Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: rewrite git-refs readme #24643

Merged
merged 2 commits into from
Sep 25, 2023
Merged

docs: rewrite git-refs readme #24643

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0733343
docs: rewrite git-refs readme
HonkingGoose Sep 25, 2023
547cda2
Update readme.md
HonkingGoose Sep 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions lib/modules/datasource/git-refs/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
This datasource can be used in combination with [regex managers](https://docs.renovatebot.com/modules/manager/regex/) to keep dependencies up-to-date which are not specifically supported by Renovate.
You can use this datasource plus [regex managers](https://docs.renovatebot.com/modules/manager/regex/) to update git-based dependencies that are not natively supported by Renovate.

The `git-refs` datasource returns a reference from a Git repository.
HonkingGoose marked this conversation as resolved.
Show resolved Hide resolved

This datasource returns a reference from a Git repository.
The `packageName` must be a fully qualified domain name.
To fetch the latest digest of a reference instead of the named reference, specify the reference as the `currentValue` and match on the `currentDigest`.

To fetch the latest _digest_ of a reference instead of the named reference: put the named reference in `currentValue` and match on the `currentDigest`.

**Usage example**

The following is an example where you would maintain the HEAD digest of the `master` branch of a repository.
You would configure a custom manager in `renovate.json` for files named `versions.ini`:
Say you want to maintain the `HEAD` digest of the `master` branch of a repository.
You would configure a custom manager in your Renovate config file for files named `versions.ini`:

```json
{
Expand Down