|
| 1 | +# Changelog Fragments |
| 2 | + |
| 3 | +The OpenXR specification editor uses the "proclamation" package to assemble |
| 4 | +changelogs for each public release, which incorporate fragments of changelog |
| 5 | +text added by the author of a change in one of these directories. |
| 6 | + |
| 7 | +If you want to preview the changelog or perform a release, you can run a command |
| 8 | +like the following to install it locally: |
| 9 | + |
| 10 | +```sh |
| 11 | +pip3 install proclamation |
| 12 | +``` |
| 13 | + |
| 14 | +See <https://gitlab.com/ryanpavlik/proclamation> for more details on *proclamation*. |
| 15 | + |
| 16 | +## Fragments |
| 17 | + |
| 18 | +Each change should add a changelog fragment file, whose contents are |
| 19 | +Markdown-formatted text describing the change briefly. Reference metadata will |
| 20 | +be used to automatically add links to associated issues/merge requests/pull |
| 21 | +requests, so no need to add these in your fragment text. |
| 22 | + |
| 23 | +## References |
| 24 | + |
| 25 | +The changelog fragment system revolves around "references" - these are issue |
| 26 | +reports, public pull requests, or private pull requests associated with a |
| 27 | +change. Each fragment must have at least one of these, which forms the main part |
| 28 | +of the filename. If applicable, additional can be added within the file - see |
| 29 | +below for details. |
| 30 | + |
| 31 | +The format of references for internal issues/MRs is: |
| 32 | + |
| 33 | +```txt |
| 34 | +<ref_type>.<number>.gl |
| 35 | +``` |
| 36 | + |
| 37 | +where |
| 38 | + |
| 39 | +- `ref_type` is "issue" or "mr" |
| 40 | +- `number` is the issue or MR number |
| 41 | +- `gl` refers to internal GitLab. |
| 42 | + |
| 43 | +The format of references for public (GitHub) issues/pull requests is: |
| 44 | + |
| 45 | +```txt |
| 46 | +<ref_type>.<number>.gh.<repo_name> |
| 47 | +``` |
| 48 | + |
| 49 | +where |
| 50 | + |
| 51 | +- `ref_type` is "issue" or "pr" |
| 52 | +- `number` is the issue or PR number |
| 53 | +- `gh` refers to public GitHub |
| 54 | +- `repo_name` is the repository name: one of "OpenXR-Docs", "OpenXR-SDK-Source", |
| 55 | + etc. |
| 56 | + |
| 57 | +Your changelog fragment filename is simply the "main" reference with the `.md` |
| 58 | +extension added. |
| 59 | + |
| 60 | +To specify additional references in a file, prefix the contents of the changelog |
| 61 | +fragment with a block delimited above and below by `---`, with one reference on |
| 62 | +each line. (This can be seen as a very minimal subset of "YAML Front Matter", if |
| 63 | +you're familiar with that concept.) For example: |
| 64 | + |
| 65 | +```md |
| 66 | +--- |
| 67 | +- issue.35.gl |
| 68 | +- mr.93.gl |
| 69 | +--- |
| 70 | +Your changelog fragment text goes here. |
| 71 | +``` |
0 commit comments