summaryrefslogtreecommitdiff
path: root/vendor/hyper-rustls/RELEASING.md
diff options
context:
space:
mode:
authormo khan <mo@mokhan.ca>2025-07-10 13:11:11 -0600
committermo khan <mo@mokhan.ca>2025-07-10 13:11:11 -0600
commit01959b16a21b22b5df5f16569c2a8e8f92beecef (patch)
tree32afa5d747c5466345c59ec52161a7cba3d6d755 /vendor/hyper-rustls/RELEASING.md
parentff30574117a996df332e23d1fb6f65259b316b5b (diff)
chore: vendor dependencies
Diffstat (limited to 'vendor/hyper-rustls/RELEASING.md')
-rw-r--r--vendor/hyper-rustls/RELEASING.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/vendor/hyper-rustls/RELEASING.md b/vendor/hyper-rustls/RELEASING.md
new file mode 100644
index 00000000..bcc0a699
--- /dev/null
+++ b/vendor/hyper-rustls/RELEASING.md
@@ -0,0 +1,26 @@
+# Making a hyper-rustls release
+
+This is a checklist for steps to make before/after making a rustls release.
+
+1. Attend to the README.md: this appears on crates.io for the release, and can't be edited after
+ the fact.
+ - Ensure the version has a good set of release notes. Move old release notes to OLDCHANGES.md
+ if this is getting excessively long.
+ - Write the version and date of the release.
+2. Run `cargo update` followed by `cargo outdated`, to check if we have any
+ dependency updates which are not already automatically taken by their semver specs.
+ - If we do, take them if possible with separate commits (but there should've been
+ dependabot PRs submitted for these already.)
+3. Now run `cargo test --all-features` to ensure our tests continue to pass with the
+ updated dependencies.
+4. Update `Cargo.toml` to set the correct version.
+5. Make a commit with the above changes, something like 'Prepare $VERSION'. This
+ should not contain functional changes: just versions numbers, and markdown changes.
+6. Do a dry run: check `cargo publish --dry-run`
+7. Push the above commit. Wait for CI to confirm it as green.
+ - Any red _should_ naturally block the release.
+ - If rustc nightly is broken, this _may_ be acceptable if the reason is understood
+ and does not point to a defect.
+8. Tag the released version: `git tag -m '0.20.0' v/0.20.0`
+9. Push the tag: `git push --tags`
+10. Do the release: `cargo publish`.