Skip to content

Commit 061de8c

Browse files
committed
Update release.yml workflow documentation to include GH app setup
1 parent 84b17f7 commit 061de8c

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,3 +159,35 @@ This workflow automatically creates GitHub tagged releases based on the tag of t
159159
```bash
160160
auto init
161161
```
162+
163+
4) Create repository tags
164+
165+
This will allow you to tag your PRs and control the semantic version changes.
166+
167+
```bash
168+
auto create-labels
169+
```
170+
171+
5) Create a GitHub App
172+
173+
***Note:** OpenLabsX already has the `auto-release-app` installed. Skip to step 7.*
174+
175+
This allows us to enforce branch protection rules while allowing the Auto release tool to bypass the protections when running automated workflows. (Source: [Comment Link](https://github.com/orgs/community/discussions/13836#discussioncomment-8535364))
176+
177+
Link: [Making authenticated API requests with a GitHub App in a GitHub Actions workflow](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow)
178+
179+
6) Configure the app with the following permissions
180+
181+
* Actions (read/write)
182+
* Administration (read/write)
183+
* Contents (read/write)
184+
185+
7) Update the ruleset bypass list to include the GitHub App
186+
187+
8) Add GitHub app variables and secrets
188+
189+
**Variables:**
190+
* `AUTO_RELEASE_APP_ID`
191+
192+
**Secrets:**
193+
* `AUTO_RELEASE_APP_PRIVATE_KEY`

0 commit comments

Comments
 (0)