ManageIQ / ManageIQ/miq_bot

General enable/disable support

Open
#246 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted pinned
Dominant language
Ruby
Stars
16
Forks
39
Avg merge
1d 11h
Merged PRs (30d)
8

Description

We have some enable/disable support in a number of workers, but many don't have it, such as the RubocopChecker, which is requested in #244. Also, the enable/disable support is a little inconsistent, so I'm thinking something more generic across the board would be very useful.

Additionally, this might allow us to separate out any private things (such as where the bot needs access to behind-the-firewall resources) from public things (such as where the bot may want to respond to a webhook), and allow us to run 2 bot instances (one internal and one external).

I'm thinking the configuration could be something similar to how rubocop itself works. So, within the bot we specify sensible defaults for most repos:

AllWorkers:
  Enabled: true
SqlMigrationChecker:
  Enabled: false

Then there can optionally be an .miq-bot.yml file within each repo where they can choose to enable or disable a specific worker (or in the future provide other options that can be overridden). So, for example, in manageiq-ui-service, they don't need the RubocopChecker at all since their linting is all done in Travis. Thus, they might have a file like:

RubocopChecker:
  Enabled: false

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing enable/disable handling across workers, including RubocopChecker, and the related request in #244. Compare that behavior with the proposed AllWorkers defaults and per-repository .miq-bot.yml configuration. Done means the project has a settled generic configuration design covering worker overrides and separate bot instances.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.