Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GitHub app for PR validation #1

Open
romanrostislavovich opened this issue Jun 26, 2018 · 3 comments
Open

GitHub app for PR validation #1

romanrostislavovich opened this issue Jun 26, 2018 · 3 comments
Assignees

Comments

@romanrostislavovich
Copy link
Member

To check PR's validity a GitHub Bot should be created which runs a console command and send its results back to the PR.

The bot should work based on the following principles:

  1. Trigger if there's a new PR;
  2. Run a console command and report its results to the PR;
  3. Bot's work result can be o two types: OK or Reject
    image

For bot's creation you'll need:

Implementation should include:

  1. Public GitHub repository cloning to a temporary folder using GIT. After GitHub Bot's work regardless of its result this temporary folder should be deleted with all its contents.
  2. Command launch and its answer analysis from the temporary folder.
  3. Sending request to a PR about PR's successful check in case the command didn't cause any errors. In case it did, Reject status should be sent.
  4. Configuration file which should contain:
    4.1. GitHubToken - required attribute
    4.2. GitHubName - Bot's name: optional, linter-bot by default
    4.3. GitHubURL - link to a Bot: optional, repometric.com by default
    4.4. TempPath - path to a temporary folder: optional, temp by default
    4.5. GitPath - path to GIT work directory: optional, /usr/bin/git/ by default
  5. Possibility of Bot's run:
    5.1 locally - possibility to run the Bot locally is required
    5.2 via docker - launching the Bot via docker with the possibility of parameters configuration transfer
    5.3 via the cloud (using docker) - using the Bot in the cloud (using docker)
  6. Logging during the Bot's running

Components that might help you:

@romanrostislavovich romanrostislavovich self-assigned this Jun 26, 2018
romanrostislavovich added a commit to romanrostislavovich/github-bot that referenced this issue Jun 26, 2018
Added init docs:
- `README.md` - sturture

Closes repometric#1
@xferra xferra closed this as completed in #3 Jun 26, 2018
xferra pushed a commit that referenced this issue Jun 26, 2018
Added init docs:
- `README.md` - sturture

Closes #1
@xferra xferra reopened this Jun 26, 2018
@xferra xferra changed the title Create GitHub bot which validate PR GitHub app for PR validation Jun 26, 2018
@xferra
Copy link
Member

xferra commented Jun 26, 2018

NOTE: Trigger not only when PR created, but when PR changed as well (reopened, new commits, etc.).

@xferra
Copy link
Member

xferra commented Jul 5, 2018

@repometric/contributors any volunteers?

@GlebBerjoskin
Copy link
Contributor

I'm already in progress

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants