Skip to content

Commit

Permalink
Merge pull request #133 from Aeliot-Tm/docs
Browse files Browse the repository at this point in the history
Describe integration to GitHub Actions
  • Loading branch information
Aeliot-Tm authored Oct 2, 2024
2 parents 4374e16 + 814e084 commit 6148d72
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ near development as close as possible for earlier catching of tech-debt. Soon of
So, you have to configure you integration depending on used git-server:

1. [GitLab pipelines](docs/gitlab/gitlab.md)
2. [GitHub Actions](docs/github/workflow.md)

## Configuration file

Expand Down
19 changes: 19 additions & 0 deletions docs/github/workflow.md
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.

0 comments on commit 6148d72

Please sign in to comment.