|
| 1 | +# Releasing libyaml |
| 2 | + |
| 3 | +## Version numbering |
| 4 | + |
| 5 | +libyaml follows `MAJOR.MINOR.PATCH` versioning. |
| 6 | +Patch releases contain bug fixes and security fixes only. |
| 7 | + |
| 8 | +## Pre-release checklist |
| 9 | + |
| 10 | +- [ ] All CI checks pass on the release branch |
| 11 | +- [ ] Security advisories drafted for any fixes (see below) |
| 12 | +- [ ] Downstream maintainers notified (see Downstream coordination) |
| 13 | + |
| 14 | +## Update version numbers |
| 15 | + |
| 16 | +Update the version in these files: |
| 17 | + |
| 18 | +- `announcement.msg` |
| 19 | +- `Changes` (add release entry with date) |
| 20 | +- `CMakeLists.txt` (`YAML_VERSION_MAJOR`, `YAML_VERSION_MINOR`, |
| 21 | + `YAML_VERSION_PATCH`) |
| 22 | +- `configure.ac` (`YAML_MAJOR`, `YAML_MINOR`, `YAML_PATCH`, |
| 23 | + `YAML_RELEASE`, `YAML_CURRENT`, `YAML_REVISION`) |
| 24 | + |
| 25 | +Commit and push to `release/0.x.y`. |
| 26 | + |
| 27 | +## Build release archives |
| 28 | + |
| 29 | +The GitHub workflow `.github/workflows/dist.yaml` builds archives |
| 30 | +automatically when you push to a `release/*` branch. |
| 31 | +It produces `yaml-0.x.y.tar.gz` and `yaml-0.x.y.zip`. |
| 32 | + |
| 33 | +To build manually: |
| 34 | + |
| 35 | + make docker-dist |
| 36 | + |
| 37 | +Archives are written to `pkg/docker/output/`. |
| 38 | +This requires the `yamlio/libyaml-dev` Docker image (build it with |
| 39 | +`make docker-build`). |
| 40 | + |
| 41 | +## Merge and tag |
| 42 | + |
| 43 | + git checkout master |
| 44 | + git merge release/0.x.y |
| 45 | + git tag -a 0.x.y |
| 46 | + # Paste the Changes entry as the tag message |
| 47 | + git push origin master 0.x.y |
| 48 | + |
| 49 | +## Create a GitHub release |
| 50 | + |
| 51 | +1. Go to Releases and click "Draft a new release" |
| 52 | +2. Select the tag you just created |
| 53 | +3. Title: `v0.x.y` |
| 54 | +4. Paste the changelog entry into the description |
| 55 | +5. Upload the `.tar.gz` and `.zip` archives |
| 56 | +6. Generate SHA-256 checksums and include them in the release notes |
| 57 | +7. Publish |
| 58 | + |
| 59 | +## Security release process |
| 60 | + |
| 61 | +For releases that fix security vulnerabilities: |
| 62 | + |
| 63 | +### Before the release |
| 64 | + |
| 65 | +1. Draft a GitHub Security Advisory (GHSA) for each vulnerability |
| 66 | + via the Security tab |
| 67 | +2. Request a CVE ID through GitHub (they are a CNA) |
| 68 | +3. Set the patched version in the advisory |
| 69 | +4. Notify Tier 1 downstream maintainers listed in `Adopters.md` |
| 70 | + so they can prepare updated packages |
| 71 | + |
| 72 | +### On release day |
| 73 | + |
| 74 | +1. Publish all drafted GHSAs |
| 75 | +2. Push the signed tag and publish the GitHub release |
| 76 | +3. Post to `oss-security@lists.openwall.org` |
| 77 | + |
| 78 | +### After the release |
| 79 | + |
| 80 | +1. Monitor downstream releases (PyYAML wheels, Ruby, distro packages) |
| 81 | +2. Update GHSAs with downstream advisory references as they appear |
| 82 | + |
| 83 | +## Downstream coordination |
| 84 | + |
| 85 | +For security releases, notify downstream maintainers before |
| 86 | +publishing: |
| 87 | + |
| 88 | +- **Tier 1** (direct consumers, pre-notify): PyYAML, Ruby Psych |
| 89 | +- **Tier 2** (distros): `distros@openwall.org` for embargoed issues |
| 90 | +- **Tier 3** (other bindings): public announcement on release day |
| 91 | + |
| 92 | +See `Adopters.md` for the full list. |
| 93 | + |
| 94 | +## Update pyyaml.org |
| 95 | + |
| 96 | +See <https://github.com/yaml/pyyaml.org/blob/master/ReadMe.md>. |
0 commit comments