https://github.com/apify/pull-request-toolkit-action
The Github action that makes sure that each PR is correctly set up and has a milestone set.
https://github.com/apify/pull-request-toolkit-action
Last synced: 3 months ago
JSON representation
The Github action that makes sure that each PR is correctly set up and has a milestone set.
- Host: GitHub
- URL: https://github.com/apify/pull-request-toolkit-action
- Owner: apify
- License: apache-2.0
- Created: 2021-03-29T16:44:56.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-29T09:27:28.000Z (over 1 year ago)
- Last Synced: 2024-12-06T07:34:24.902Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 1.55 MB
- Stars: 1
- Watchers: 10
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pull request toolkit
This action automates a couple of processes connected with the management of GitHub pull requests.
# What it does
- Assigns PR to its creator.
- Fills a missing milestone with a current milestone from Zenhub.
- Assigns a team label (`t-[teamName]`) to the pull request.
- Makes sure that:
- PR is either linked with epic or issue or labeled as `adhoc`
- PR itself or linked issue is estimated
## Wishlist / TODOs
- GitHub action for publishing of a new version.
- GitHub action for lint and tests execution.
- Use Docker image with runtime typescript compilation instead of committing a dist directory.
# Action input
| Name | Description | Example | Required |
|----------------|----------------------------------------------------|----------------|----------|
| `repo-token` | Repository GitHub token | `github-token` | yes |
| `org-token` | GitHub token with read only access to organization | `github-token` | yes |
| `zenhub-token` | GitHub token with read only access to organization | `zenhub-token` | yes |
# Example usage
```yaml
name: Apify PR toolkit
on:
pull_request:
branches:
- develop
jobs:
apify-pr-toolkit:
runs-on: ubuntu-20.04
steps:
- name: clone pull-request-toolkit-action
uses: actions/checkout@v2
with:
repository: apify/pull-request-toolkit-action
ref: refs/tags/v1.0.1
path: ./.github/actions/pull-request-toolkit-action
- name: run pull-request-toolkit action
uses: ./.github/actions/pull-request-toolkit-action
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
org-token: ${{ secrets.PULL_REQUEST_TOOLKIT_ACTION_GITHUB_TOKEN }}
zenhub-token: ${{ secrets.PULL_REQUEST_TOOLKIT_ACTION_ZENHUB_TOKEN }}
```
# Contribution
1. Update code in `./src`
2. Run `npm i`
3. Run `npm run all`
4. Commit all changes including `./dist` folder with built code.
5. Publish a new version of an action using the new release (It needs to be done manually)