https://github.com/movableink/pr-clubhouse-lint-action
Ensures all pull requests have clubhouse card numbers attached
https://github.com/movableink/pr-clubhouse-lint-action
Last synced: 2 months ago
JSON representation
Ensures all pull requests have clubhouse card numbers attached
- Host: GitHub
- URL: https://github.com/movableink/pr-clubhouse-lint-action
- Owner: movableink
- License: mit
- Created: 2019-10-01T00:30:49.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-30T04:17:26.000Z (10 months ago)
- Last Synced: 2025-03-02T22:20:23.215Z (3 months ago)
- Language: JavaScript
- Size: 1.07 MB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pr-shortcut-lint-action
A GitHub Action that verifies your pull request contains a reference to a Shortcut card. If your Shortcut card number is 1234, this will check for `[ch1234]` or `ch1234/` in:
* The pull request title
* The pull request body
* The pull request branch name
## Usage
Add `.github/workflows/lint.yaml` with the following:
```yaml
name: Shortcut
on:
pull_request:
types: [opened, edited, reopened, synchronize]
jobs:
ch_lint_pr:
name: Check for story ID
runs-on: ubuntu-latest
steps:
- uses: movableink/pr-clubhouse-lint-action@release
```
## Releasing
This action needs `node_modules` vendored, but we don't want to do so normally. To release a new version:
* Remove `node_modules`
* Check out the `release` branch
* Run `git merge master`
* Run `npm install --production` (to ensure dev dependencies don't get installed)
* Commit the result, if any changes
* Push the `release` branch to Github
## Testing
Run `npm test` to test.