Skip to content

feat(chore): add troubleshooting guide#64

Merged
camillecroft merged 4 commits into
mainfrom
chore/add-troubleshooting-doc
Jun 1, 2026
Merged

feat(chore): add troubleshooting guide#64
camillecroft merged 4 commits into
mainfrom
chore/add-troubleshooting-doc

Conversation

@camillecroft
Copy link
Copy Markdown
Contributor

Added a troubleshooting guide based on recent issues encountered in the csda-data-monitoring repo.

@camillecroft camillecroft requested a review from a team May 27, 2026 15:50
@camillecroft camillecroft requested a review from emmalu as a code owner May 27, 2026 15:50
Comment thread docs/troubleshooting.md
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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, this is helpful to learn! 🙌🏽

Comment thread docs/troubleshooting.md Outdated
Comment thread docs/troubleshooting.md
Copy link
Copy Markdown
Contributor

@emmalu emmalu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This generally LGTM, although I'd be curious if @gadomski can think of any other common issues to work through?

Comment thread docs/troubleshooting.md Outdated
Copy link
Copy Markdown
Contributor

@gadomski gadomski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@camillecroft camillecroft requested a review from emmalu June 1, 2026 17:01
Comment thread docs/troubleshooting.md
Comment on lines +3 to +5
This guide applies to any CSDA repository that uses the release-please action. Each repo must include a `.github/workflows/release-please.yml` workflow and grant the CSDA release app repository access. Use this guide when a release fails, versions become stale, workflows report permission errors or release-please ignores configuration changes.

For guidance on the overall release and deployment process, see the CSDA project wiki: [Code Releases (Deployments)](https://github.com/NASA-IMPACT/csda-project/wiki/Code-Releases-(Deployments)).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this context! 🙌🏽

@camillecroft camillecroft merged commit 85fbc36 into main Jun 1, 2026
2 checks passed
@camillecroft camillecroft deleted the chore/add-troubleshooting-doc branch June 1, 2026 22:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants