From 8de546fcd84deefd7010a21ddcfe6d2d5809632e Mon Sep 17 00:00:00 2001 From: Kimiaki Kuno Date: Sun, 12 Sep 2021 23:44:46 +0900 Subject: [PATCH] docs: README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index fc39dd5f..c516ce5e 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,29 @@ A GitHub Actions for cleaning issues of OSS Gate Workshop repository +## Usage + +Write a workflow file as follows at .github/worfklow/issue.yaml in your repository. + +```yaml +on: [workflow_dispatch] + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: oss-gate/issue-cleaner@v2 + with: + DOORKEEPER_GROUP: oss-gate + env: + DOORKEEPER_TOKEN: ${{ secrets.DOORKEEPER_TOKEN }} +``` + +## Release flow + +Using [technote-space/release-github-actions](https://github.com/technote-space/release-github-actions). + ## Contributing If you have suggestions for how oss-gate-issue-cleaner could be improved, or want to report a bug, open an issue! We'd love all and any contributions.