LanguageValues and typesStandard typesSoftware
GitRef
On this page
A git branch, tag, full ref or commit hash: main, refs/tags/v1.2.0.
Use it to record what a build came from. For a package, use PackageUrl.
Shape
One value, held as text in one set form, with no parts: 8d3f2a1c9b7e6d5f4a3b2c1d0e9f8a7b6c5d4e3f.
Example
GitRef("main")GitRef(raw) checks the text, and text that isn't one breaks the format rule.
text.parse(raw, as: GitRef) reads one from text that comes from outside. Text that isn't one at all fails malformed, such as .hidden, refs/heads/.hidden or main.lock.
Good to know
- It follows git's own naming rules, so a name starting with
.is refused. ==tells you whether two are the same.<andlist.sort_bydon't take it.
In JSON
A string, in a request, a response or json.write:
"main""refs/heads/feature/x-1""v1.2.0"
Details
Text form, storage, how it is shown, and operations
GitRef is in the group Software, and has been in Jadpo since 0.1.0.
Text form
text.from writes one standard text form, the same form text.parse reads back: main, refs/heads/feature/x-1 and v1.2.0.
How it is stored
It is stored in one column named for the field, of type text. v1.2.0 is stored as 'v1.2.0'.
How it is shown to people
text.format(value, locale:) shows it to people in their locale.
With locale: Locale.en_gb:
| Value | Shown |
|---|---|
main |
main |
refs/heads/feature/x-1 |
refs/heads/feature/x-1 |
v1.2.0 |
v1.2.0 |
8d3f2a1c9b7e6d5f4a3b2c1d0e9f8a7b6c5d4e3f |
8d3f2a1c9b7e6d5f4a3b2c1d0e9f8a7b6c5d4e3f |
Operations
It also takes text.parse, text.from, text.format, json.read, json.write and ==. How every standard type behaves says how they work.
Markdown for agents: /docs/types/type-git-ref.md.Built from Jadpo main at aee2e8f.