Automatically find issues updated within the given time period and add them to a GitHub Project.
Input variable | Description | Required | Default |
---|---|---|---|
ACCESS_TOKEN |
An authorised Personal Access Token from GitHub | yes | |
ORG_NAME |
The GitHub username of the organisation | yes | |
PROJECT_NUMBER |
The number of the project board within the org | yes | |
COLUMN_NAME |
The name of the column within the project board | yes | |
EXCLUDED_PROJECT_NUMBER |
The number of the excluded project within the org | no | -1 |
ISSUE_TYPE |
Whether to find new issues, PRs or both | no | any |
INTERVAL |
The time interval to check for updated issues | no | 1 |
INTERVAL_UNIT |
The unit of the time interval to check for updated issues | no | d |
- Clone the repo.
$ gh repo clone dhruvkb/issue-projector
- Install dependencies.
$ npm install
- Export environment variables into the current shell by creating an
.env
file. This variables defined in the file are a little different because we prependINPUT_
to each of the inputs that the script takes.INPUT_ACCESS_TOKEN='REDACTED' INPUT_ORG_NAME='purelyfortesting' INPUT_PROJECT_NUMBER='1' INPUT_COLUMN_NAME='Pending_Review' INPUT_EXCLUDED_PROJECT_NUMBER='2' INPUT_ISSUE_TYPE='any' INPUT_INTERVAL='4' INPUT_INTERVAL_UNIT='h'
- Run the TypeScript build server that watches the files and recompiles them
upon changes.
$ npm run watch
- Execute the compiled script.
$ npm run exec
develop
: This is- the primary branch for the repo
- the one to which all code is pushed
- the one to which all PRs should be directed to
master
: This is- not the primary branch of the repo, contrary to what the name implies so
- the one to which Travis pushes the built assets
- the one from which GitHub Releases are drafted