summaryrefslogtreecommitdiffstats
path: root/vendor/git2/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-30 18:31:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-30 18:31:44 +0000
commitc23a457e72abe608715ac76f076f47dc42af07a5 (patch)
tree2772049aaf84b5c9d0ed12ec8d86812f7a7904b6 /vendor/git2/CONTRIBUTING.md
parentReleasing progress-linux version 1.73.0+dfsg1-1~progress7.99u1. (diff)
downloadrustc-c23a457e72abe608715ac76f076f47dc42af07a5.tar.xz
rustc-c23a457e72abe608715ac76f076f47dc42af07a5.zip
Merging upstream version 1.74.1+dfsg1.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/git2/CONTRIBUTING.md')
-rw-r--r--vendor/git2/CONTRIBUTING.md22
1 files changed, 9 insertions, 13 deletions
diff --git a/vendor/git2/CONTRIBUTING.md b/vendor/git2/CONTRIBUTING.md
index d8ab92232..1ab0961f1 100644
--- a/vendor/git2/CONTRIBUTING.md
+++ b/vendor/git2/CONTRIBUTING.md
@@ -24,9 +24,8 @@ The following steps can be used to update libgit2:
`cargo test -p git2 -p git2-curl` is a good starting point.
4. Run `systest`.
This will validate for any C-level API problems.
- Unfortunately `systest` does not work on nightly, so you'll need to use stable.
- `cargo +stable run -p systest`
+ `cargo run -p systest`
The changelog at <https://github.com/libgit2/libgit2/blob/main/docs/changelog.md>
can be helpful for seeing what has changed.
@@ -52,15 +51,12 @@ Checklist for preparing for a release:
- [`libgit2-sys/CHANGELOG.md`](https://github.com/rust-lang/git2-rs/blob/master/libgit2-sys/CHANGELOG.md)
- [`git2-curl/CHANGELOG.md`](https://github.com/rust-lang/git2-rs/blob/master/git2-curl/CHANGELOG.md)
-To publish the new release:
+There is a GitHub workflow to handle publishing to crates.io and tagging the release. There are two different ways to run it:
-- In a fresh clone, make sure you run `git submodule update`.
-- For each updated package, run `cargo publish` (`libgit2-sys` then `git2` then `git2-curl`).
-- Set tags for each package that was update:
- - `git tag 0.16.1`
- - `git tag libgit2-sys-0.14.2+1.5.1`
- - `git tag git2-curl-0.17.0`
-- Push the tags (substitute the "origin" remote name if you are using a different name):
- - `git push origin 0.16.1`
- - `git push origin libgit2-sys-0.14.2+1.5.1`
- - `git push origin git2-curl-0.17.0`
+- In the GitHub web UI:
+ 1. Go to <https://github.com/rust-lang/git2-rs/actions/workflows/publish.yml> (you can navigate here via the "Actions" tab at the top).
+ 2. Click the "Run workflow" drop-down on the right.
+ 3. Choose which crates to publish. It's OK to leave everything checked, it will skip if it is already published. Uncheck a crate if the version has been bumped in git, but you don't want to publish that particular one, yet.
+ 4. Click "Run workflow"
+- In the CLI:
+ 1. Run `gh workflow run publish.yml -R rust-lang/git2-rs`