diff options
| author | Alex Pooley (@zuedev) <zuedev@gmail.com> | 2026-02-05 15:57:29 +0000 |
|---|---|---|
| committer | Alex Pooley (@zuedev) <zuedev@gmail.com> | 2026-02-05 15:57:29 +0000 |
| commit | c58326c3d8ff3fb766b83e6919a5b8d4731cbcbd (patch) | |
| tree | b4cbab36ce2cdeb8e33ddac8b7b5ed468de477ed /README.md | |
| parent | 30f2e0aca660e3742161ee7a16d72bb38eb35180 (diff) | |
| download | gitinfo-c58326c3d8ff3fb766b83e6919a5b8d4731cbcbd.tar gitinfo-c58326c3d8ff3fb766b83e6919a5b8d4731cbcbd.tar.gz gitinfo-c58326c3d8ff3fb766b83e6919a5b8d4731cbcbd.tar.bz2 gitinfo-c58326c3d8ff3fb766b83e6919a5b8d4731cbcbd.tar.xz gitinfo-c58326c3d8ff3fb766b83e6919a5b8d4731cbcbd.zip | |
add ci, issues, chat, and docs fields
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 8 insertions, 0 deletions
@@ -80,6 +80,10 @@ All keys are optional. Include only the fields relevant to your project. - `homepage`: The URL of the project's homepage or documentation site, if separate from the repository. - `funding`: A list of URLs for sponsorship or funding platforms (e.g., GitHub Sponsors, Open Collective, Patreon). - `version`: The version of the `.gitinfo` schema being used for this file. Can be a semver string (e.g., `1.0.0`) or a git commit hash. +- `ci`: The URL of the CI/CD platform or pipeline status page for the repository. +- `issues`: The URL of the issue tracker, if different from the root repository. +- `chat`: The URL of a community chat platform (e.g., Discord, Matrix, Slack, IRC). +- `docs`: The URL of the project's documentation site. ### Validation Rules @@ -96,6 +100,10 @@ All keys are optional. Include only the fields relevant to your project. | `homepage` | Valid URI (http/https) | `https://example.com/project` | | `funding[]` | Valid URI (http/https) | `https://github.com/sponsors/user` | | `version` | Semver or commit hash | `1.0.0`, `a1b2c3d4e5f6...` | +| `ci` | Valid URI (http/https) | `https://github.com/user/repo/actions` | +| `issues` | Valid URI (http/https) | `https://github.com/user/repo/issues` | +| `chat` | Valid URI (http/https) | `https://discord.gg/example` | +| `docs` | Valid URI (http/https) | `https://docs.example.com` | ## Usage |
