Skip to content

Commit

Permalink
Add some troubleshooting tips (#283)
Browse files Browse the repository at this point in the history
* Add some troubleshooting tips

* one more

* Apply suggestions from code review

Co-authored-by: Ian Butterworth <i.r.butterworth@gmail.com>

---------

Co-authored-by: Ian Butterworth <i.r.butterworth@gmail.com>
  • Loading branch information
ericphanson and IanButterworth committed Sep 18, 2023
1 parent 7ac5878 commit 8e26773
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -496,3 +496,20 @@ $ cd TagBot
$ poetry install
$ poetry run python -m tagbot.local --help
```

## Troubleshooting tips

### I am seeing some kind of permissions error

* Check that your configuration matches the one shown in [Setup](#Setup), especially the `permissions` block
* Try using an [ssh deploy key](#SSH-Deploy-Keys) even if you aren't using Documenter or otherwise need to trigger workflows from TagBot-generated tags

### I am missing old tags

If you have missed tags due to now-fixed errors, you can manually trigger TagBot with a longer "lookback" period (days) in order to try to find them (assuming your workflow has been configured as shown in [Setup](#Setup) with a `workflow_dispatch` trigger). See the [Github docs](https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow) for more on manually running workflows.

### The workflow shows as "successful" even though errors have occurred

This is by design, because in the past transient GitHub issues or even broken TagBot releases have caused widespread notifications and issues due to the workflow failing. Instead, TagBot is set up to re-run several times after a release until the tag is successfully created, and to comment in the TagBot trigger issue if it has not been created.

Note that in the future this approach may change, e.g. specific errors may be made to fail the workflow while others may still not.

0 comments on commit 8e26773

Please sign in to comment.