change(release): Update release script and check it in CI

[teor2345]

Motivation

The script in our release checklist doesn't actually work.

Specifications

cargo release command reference:
https://github.com/crate-ci/cargo-release/blob/master/docs/reference.md

Complex Code or Requirements

This PR works around a cargo publish unpublished version resolution bug, by skipping the failing Zebra crates:
crate-ci/cargo-release#691

This bug only happens in dry runs, publishing crates works fine.

Solution

Release Checklist Fixes:

• Update the release script so it works
  • Fix doc version replacements and add them to the script
• Add and remove do-not-merge tags at the right times
• Fix a command that's easy to accidentally run on the wrong version

Release Config Fixes:

• Add a release config to simplify release commands and apply default new crate settings
• Fix a release warning about an outdated default-features spelling
• Remove a redundant elasticsearch feature dependency that caused release errors

CI:

• Check that the release script works by running it on each PR (but skip crates that fail dry run checks)
• Add special arguments that are needed for non-interactive release dry runs

Release v1.0.1 Cleanups

• Update release date
• Add a missing changelog entry
• Do missing doc version replacements

Admin Actions

• Admin: Add the new check as a branch protection rule

Review

This is a routine fix.

Reviewer Checklist

• Are the PR labels correct?
• Does the code do what the ticket and PR says?
  • Does it change concurrent code, unsafe code, or consensus rules?
• How do you know it works? Does it have tests?

Follow Up Work

We could move the script into a file
We could automate releases and do them from GitHub Actions

[codecov]

Codecov Report

Merging #7128 (f6329b4) into main (4713994) will increase coverage by 0.08%.
The diff coverage is n/a.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7128      +/-   ##
==========================================
+ Coverage   77.33%   77.41%   +0.08%     
==========================================
  Files         310      310              
  Lines       41828    41828              
==========================================
+ Hits        32347    32383      +36     
+ Misses       9481     9445      -36     

[arya2]

This looks great, thank you for getting started on automating some release steps!

I'm not sure about the workaround for cargo publish, I think it would have to be applied to every crate that depends on another crate in the workspace. It may be better to wait until there's more support for this use case, or to try an ephemeral private registry (ktra should mirror crates.io for Zebra's external deps).

[teor2345]

I'm not sure about the workaround for cargo publish, I think it would have to be applied to every crate that depends on another crate in the workspace.

This is actually a specific bug that's triggered by Zebra's dependency tree:
crate-ci/cargo-release#691

Normally, cargo would ignore missing crate versions that it's just about to publish. But Zebra triggers a bug in that code.

[teor2345]

Ok, the new job works in CI:

Packaging zebra-rpc v1.0.0-beta.28 (/home/runner/work/zebra/zebra/zebra-rpc)
Packaged 138 files, 451.8KiB (93.7KiB compressed)
Uploading zebra-rpc v1.0.0-beta.28 (/home/runner/work/zebra/zebra/zebra-rpc)
warning: aborting upload due to dry run

https://github.com/ZcashFoundation/zebra/actions/runs/5450302581/jobs/9915420110?pr=7128#step:7:235

[teor2345]

I just added this check to the branch protection rules