Skip to content

Commit

Permalink
Merge pull request #1447 from philroche/feature/git-update-repository…
Browse files Browse the repository at this point in the history
…-used

docs: Add information on the repository used with the `git` `update` configuration option
  • Loading branch information
philroche committed Aug 21, 2024
2 parents 98b252c + 7266d5b commit 41f30e3
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/UPDATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ There are currently two ways to describe where to search for latest versions of

1. `release-monitor:` to query https://release-monitoring.org/
2. `github:` to query https://github.com via it's graphql API
3. `git:` to query local git checkout

## Release Monitor

Expand Down Expand Up @@ -59,6 +60,8 @@ update:
Git uses vanilla git to check for updates. This is useful for projects that use unsupported Git Provider APIs.
The git repository queried is the first repository specified in the `pipeline: / uses: git-checkout` section of the melange config.

It is recommended to use a `schedule` as described below when using Git as this is a less performant approach to using APIs such as GitHub and Release Monitoring.

```yaml
Expand Down

0 comments on commit 41f30e3

Please sign in to comment.