This repository has been archived by the owner on Sep 30, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor!: migrate to a nodejs action
This change will have the following impact: * Interactions with GitHub are no longer required by Commisery * Performance improvement as we no longer require a Docker image * Addition of a Summary page * No longer scan the title of the Pull Request
- Loading branch information
1 parent
a5e0913
commit 3c719ca
Showing
15 changed files
with
10,982 additions
and
396 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
node_modules/ |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Check your commits against Conventional Commits using Commisery | ||
|
||
Using this GitHub action, scan all commits in your Pull Request against the [Conventional Commits] | ||
standard using [Commisery] | ||
|
||
[Conventional Commits]: https://www.conventionalcommits.org/en/v1.0.0/ | ||
[Commisery]: https://pypi.org/project/commisery/ | ||
|
||
## Usage | ||
|
||
The workflow, usually declared in `.github/workflows/build.yml`, looks like: | ||
|
||
```yml | ||
|
||
name: Commisery | ||
on: | ||
pull_request: | ||
types: [edited, opened, synchronize, reopened] | ||
|
||
jobs: | ||
commit-message: | ||
name: Conventional Commit Message Checker (Commisery) | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Check-out the repo under $GITHUB_WORKSPACE | ||
uses: actions/checkout@v3 | ||
|
||
- name: Run Commisery | ||
uses: KevinDeJong-TomTom/commisery-action@master | ||
with: | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
pull_request: ${{ github.event.number }} | ||
``` | ||
|
||
## Inputs | ||
|
||
- **token**: GitHub Token provided by GitHub, see [Authenticating with the GITHUB_TOKEN] | ||
- **pull_request**: Pull Request number, provided by the [GitHub contex]. | ||
|
||
[Authenticating with the GITHUB_TOKEN]: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token | ||
[GitHub context]: https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#github-context | ||
|
||
|
||
## Example of Conventional Commit check results | ||
|
||
![example](resources/example.png) |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.