Skip to content

Latest commit

 

History

History
74 lines (61 loc) · 3.54 KB

README.md

File metadata and controls

74 lines (61 loc) · 3.54 KB
Raw

Python package Coverage Status

github-automation

This tool will help you maintain and organize your GitHub project using an automation tool.

Use case

In case you work with GitHub projects, and maintain a board for your project this tool is for you. As we offer a functionality of managing your board in GitHub project boards. This is by searching for the issues or pull request you wish to include in the board (By a set of filter you provide) and placing them in the right place in your board for you - both in the correct column and the correct place within the column.

The supported functionality is:

  • Adding new issues or pull requests to your board.
  • Moving issues or pull requests to the correct column of your project, with the priority in mind.
  • Sorting your issues or pull requests within your existing columns by their priorities and creation times.
  • Removing issues or pull requests that fail to meet your filters.

In order to configure github-automation you will need to create an .ini file, here is an example:

[General]
closed_issues_column = Done
merged_pull_requests_column = Merged
project_owner = ronykoz
repository_name = test
project_number = 1
priority_list = Critical,High,Medium,Low
filter_labels=bug
must_have_labels=test
cant_have_labels=not test
column_names = Queue,In progress,Review in progress,Waiting for Docs
column_rule_desc_order = Queue,Waiting for Docs,Review in progress,In progress

[Actions]
remove
add
move

[Queue]
issue.assignees = false

[In progress]
issue.assignees = true
pull_request.assignees = true

[Review in progress]
issue.assignees = true
issue.pull_request = true
issue.pull_request.review_requested = true
pull_request.review_requested = true

[Waiting for Docs]
issue.assignees = true
issue.pull_request = true
issue.pull_request.review_requested = true
issue.pull_request.review_completed = true
issue.pull_request.assignees = ronykoz

While the General and Actions sections must be in the .ini the rest of the sections are dynamic, and each represents the rules for each of your columns. The keys listed in the column section are the attributes of the classes which represent the issue or pull request you are working on. For a more detailed explanation please click here

GitHub Actions

In order to use this in a github action please follow this documentation.

Usage

There are three options to run the tool:

  1. Configure an .ini file like described above and then using the github-automation manage -c <path to ini> command or the wehbhook-manage command which is used for events.
  2. Import the code and create some more custom rules for your self, like importing issues from another board(FYI this will be added to the tool as well).
  3. GitHub actions - In order to use this in a github action please follow this documentation.

Token

In any solution you will have to set an envioroonment variable GITHUB_TOKEN which is the token you will generate in order for the tool to connect to your GitHub project. Although we do offer the option to pass that along with your client object while taking the API option(Usage case number 2).