feat(chore): add troubleshooting guide#64
Open
camillecroft wants to merge 2 commits into
Open
Conversation
emmalu
reviewed
May 28, 2026
Comment on lines
+36
to
+49
| 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 No newline at end of file |
Contributor
There was a problem hiding this comment.
Oh, this is helpful to learn! 🙌🏽
emmalu
reviewed
May 28, 2026
| @@ -0,0 +1,49 @@ | |||
| # Troubleshooting Guide | |||
|
|
|||
| #### Required Workflow Permissions | |||
Contributor
There was a problem hiding this comment.
Suggested change
| #### Required Workflow Permissions | |
| ## Required Workflow Permissions |
nit: headings should only increment +1
emmalu
reviewed
May 28, 2026
|
|
||
| #### 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 release-please.yml workflow is required in each repo)? A pointer to the wiki page could also be helpful.
emmalu
reviewed
May 28, 2026
|
|
||
| #### 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
| - Visit the [CSDA Release App installations page](https://github.com/apps/csda-release-app/installations/105597643) | |
| - Visit the [CSDA Release App installations page](https://github.com/apps/csda-release-app) and follow the authentication steps to `Configure` |
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.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Added a troubleshooting guide based on recent issues encountered in the csda-data-monitoring repo.