-
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.
Merge pull request #133 from Aeliot-Tm/docs
Describe integration to GitHub Actions
- Loading branch information
Showing
2 changed files
with
20 additions
and
0 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,19 @@ | ||
# Integration on GitHub Actions | ||
|
||
### Preconditions | ||
|
||
Add token to the secrets of repository for connection to GitHub API with permission to write contents. | ||
|
||
### Configuration of GitHub Actions | ||
|
||
You have to config [workflow](https://docs.github.com/en/actions/writing-workflows) of your project. | ||
See example [in this project](../../.github/workflows/todo-registrar.yaml). | ||
|
||
It is split on two jobs: | ||
- The first one gets count of opened Pull Request with new registered TODOs. | ||
- The second one responsible for the whole process of registration of TODOs. | ||
It is skipped when opened PRs detected by previous job to avoid duplicated registration of TODOs. | ||
|
||
**NOTE:** | ||
Pay attention that workflow of this project depends on using of its own binary file. | ||
But you have to [install](../../README.md#installation) TODO Registrar and use proper path to binary file. |