feat(chore): add troubleshooting guide #64
There are no files selected for viewing
This file contains hidden or 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,49 @@ | ||||||
| # Troubleshooting Guide | ||||||
|
|
||||||
| #### Required Workflow Permissions | ||||||
|
|
||||||
| Ensure your `.github/workflows/release-please.yml` file includes the following permissions: | ||||||
|
Contributor
There was a problem hiding this comment. Could we do a short intro on when this guide is relevant (because a |
||||||
|
|
||||||
| ```yaml | ||||||
| permissions: | ||||||
| contents: write | ||||||
| pull-requests: write | ||||||
| ``` | ||||||
|
|
||||||
| These permissions are required for release-please to: | ||||||
| - Create and update release PRs | ||||||
| - Create tags and GitHub releases | ||||||
| - Update changelog files | ||||||
|
|
||||||
| #### Verify CSDA Release App Access | ||||||
|
|
||||||
| - Visit the [CSDA Release App installations page](https://github.com/apps/csda-release-app/installations/105597643) | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
nit: I think it's nice to document the main app URL (otherwise it's hard to find!) but pointing to the specific "installation" seems unnecessary. |
||||||
| - Verify your repository is listed under `Repository access` | ||||||
| - If your repository is missing select the one you would like to add | ||||||
|
|
||||||
| ### Resolving Stale Versions in Release Please | ||||||
|
|
||||||
| **Release-Please Workflow:** | ||||||
|
|
||||||
| - When a PR is merged to `main`, release-please creates a "Release PR" with the label `autorelease: pending` | ||||||
| - When the Release PR is merged, release-please: | ||||||
| - Creates a Git tag | ||||||
| - Publishes a GitHub Release | ||||||
| - Removes `autorelease: pending` and adds `autorelease: tagged` | ||||||
|
|
||||||
| **Common problem:** | ||||||
|
|
||||||
| If the release-please action fails, it never removes the `autorelease: pending` label. This causes release-please to ignore any workflow changes and continuously retries the failed release. | ||||||
|
|
||||||
| #### Examples | ||||||
|
|
||||||
| - You update `release-as` in your workflow to a new version, but release-please keeps trying to create the old version | ||||||
| - Release-please workflow runs but ignores your configuration changes | ||||||
| - You see the error message `Resource not accessible by integration` or permission errors in the workflow logs | ||||||
|
|
||||||
| #### Solution | ||||||
|
|
||||||
| - Find the Release PR that failed with the `autorelease: pending` label | ||||||
| - Manually remove the `autorelease: pending` label from the PR | ||||||
| - Re-run the release-please workflow | ||||||
| - This clears release-please's "memory" of the failed release and allows it to read your updated configuration | ||||||
|
Comment on lines
+36
to
+49
Contributor
There was a problem hiding this comment. Oh, this is helpful to learn! 🙌🏽 |
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: headings should only increment +1