Skip to content

Commit

Permalink
Update README to address #20 and #40
Browse files Browse the repository at this point in the history
Hopefully this documents the issue folks have seen in #20 and #40
  • Loading branch information
metcalfc committed Dec 9, 2020
1 parent eed6d76 commit 9618b88
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Expand Up @@ -20,7 +20,7 @@ The name of the head reference. Default `${{github.sha}}`.

### `base-ref`

The name of the second branch. Defaults to the `tag_name` of the latest release.
The name of the second branch. Defaults to the `tag_name` of the latest GitHub release. *This must be a GitHub release. Git tags or branches will not work.*

## Outputs

Expand Down Expand Up @@ -72,6 +72,18 @@ updates:
schedule:
interval: 'daily'
```
## Troubleshooting

### Error not found

```
Error: Not Found
```

If you are seeing this error its likely that you do not yet have a GitHub release. You might have a git tag and that shows up in the release tab. The
API this Action uses only works with GitHub Releases. Covnert one of your tags to a release and you'll be on your way. You can check out how this
repository uses this action and GitHub releases for an [example](.github/workflows/release.yml).


## Acknowledgements

Expand Down

0 comments on commit 9618b88

Please sign in to comment.