aboutsummaryrefslogtreecommitdiffstats
path: root/extra/HOWTO_release.md
diff options
context:
space:
mode:
authorbryan newbold <bnewbold@robocracy.org>2023-03-04 19:39:08 -0800
committerbryan newbold <bnewbold@robocracy.org>2023-03-04 19:39:08 -0800
commit21ab7252e7b354d6b94a544037906405ad3a078d (patch)
treeef28829eec2ac67bd1e5dd08449a44671b90d887 /extra/HOWTO_release.md
parentd49c1d20fd31054c56317bd117acd10aafe613ce (diff)
downloadadenosine-21ab7252e7b354d6b94a544037906405ad3a078d.tar.gz
adenosine-21ab7252e7b354d6b94a544037906405ad3a078d.zip
release process: mention --allow-dirty
Diffstat (limited to 'extra/HOWTO_release.md')
-rw-r--r--extra/HOWTO_release.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/extra/HOWTO_release.md b/extra/HOWTO_release.md
index eb95679..0b47142 100644
--- a/extra/HOWTO_release.md
+++ b/extra/HOWTO_release.md
@@ -8,11 +8,11 @@ final prep:
- update CHANGELOG and increment version in `adenosine-*/Cargo.toml`. `make build` to
update `Cargo.lock`, then commit
- `make test`, `make deb` and ensure build works and is clean
-- ensure working directory is *entirely* clean (no "Untracked files" or edits,
- even if unrelated to code changes)
+- ensure working directory is clean (no edits, even if unrelated to code changes)
push/tag/etc:
-- when project is ready to share on crates.io, do: push to crates.io: `cargo publish -p adenosine-cli`, `cargo publish -p adenosine-pds`
+- when project is ready to share on crates.io, do: push to crates.io: `cargo publish -p adenosine-cli`, `cargo publish -p adenosine-pds`, `cargo publish -p adenosine`
+ => add `--allow-dirty` if you have local "untracked" git files (and are confident!)
=> usually want to do this before git tag in case validation details come up
- create a git tag: `git tag vX.Y.Z -a -s -u bnewbold@archive.org -m "release X.Y.Z"`
- push git and tag: `git push`, `git push --tags`