Skip to content

Commit 057312e

Browse files
committed
Update releasing instructions
1 parent fcb5d32 commit 057312e

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

RELEASING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
## Pre-release
22

3+
1. Clean up clippy lints
4+
1. Run `cargo audit` and fix any issues
35
1. Generate protos
4-
1. Run `cd tensorflow-proto-codegen; cargo run -- $PATH_TO_TENSORFLOW $PWD/..`
6+
1. Run `cd tensorflow-proto-codegen; cargo run -- ${PATH_TO_TENSORFLOW?} $PWD/..`
57
1. Update Cargo.toml in root and tensorflow-op-codegen to ensure version of protobuf exactly equals version of protoc_rust used
68
1. Generate ops
7-
1. Run `cd tensorflow-op-codegen; cargo run -- $PATH_TO_TENSORFLOW $PWD/..`
8-
1. Run `cd tensorflow-op-codegen; cargo run --bin eager -- $PATH_TO_TENSORFLOW $PWD/..`
9+
1. Run `cd tensorflow-op-codegen; cargo run -- ${PATH_TO_TENSORFLOW?} $PWD/..`
10+
1. Run `cd tensorflow-op-codegen; cargo run --bin eager -- ${PATH_TO_TENSORFLOW?} $PWD/..`
911
1. Run `cargo fmt` to format generated code
1012
1. Commit and push changes
1113

@@ -19,12 +21,12 @@ Note that any crate not mentioned here (e.g. tensorflow-proto-codegen, tensorflo
1921
1. Ensure that the minimum supported Rust version in the README is up to date
2022
1. Update changelog.
2123
1. Bump version number of `tensorflow-sys` if necessary
22-
1. Run `git log v${PREVIOUS_VERSION}..HEAD tensorflow-sys` and see if there were any changes. If not, skip.
24+
1. Run `git log v${PREVIOUS_VERSION?}..HEAD tensorflow-sys` and see if there were any changes. If not, skip.
2325
1. Bump the version in `tensorflow-sys/Cargo.toml`
2426
1. Bump the version in `tensorflow-sys/README.md`
2527
1. Bump the version for `tensorflow-sys` in the root `Cargo.toml`
2628
1. Bump version number of `tensorflow-internal-macros` if necessary
27-
1. Run `git log v${PREVIOUS_VERSION}..HEAD tensorflow-internal-macros` and see if there were any changes. If not, skip.
29+
1. Run `git log v${PREVIOUS_VERSION?}..HEAD tensorflow-internal-macros` and see if there were any changes. If not, skip.
2830
1. Bump the version in `tensorflow-internal-macros/Cargo.toml`
2931
1. Bump the version for `tensorflow-internal-macros` in the root `Cargo.toml`
3032
1. Bump the version number in `Cargo.toml`
@@ -36,7 +38,7 @@ Note that any crate not mentioned here (e.g. tensorflow-proto-codegen, tensorflo
3638
1. If the version of tensorflow-sys was bumped, run `cargo publish` for tensorflow-sys. (Publish before tagging in case there are problems publishing and we need to add commits to fix them.)
3739
1. If the version of tensorflow-internal-macros was bumped, run `cargo publish` for tensorflow-internal-macros. (Publish before tagging in case there are problems publishing and we need to add commits to fix them.)
3840
1. Run `cargo publish`. (Publish before tagging in case there are problems publishing and we need to add commits to fix them.)
39-
1. Add a `v${VERSION}` tag and push it
41+
1. Add a `v${VERSION?}` tag and push it
4042
1. Run `./update-docs`
4143
1. Announce the release to the mailing list
4244

0 commit comments

Comments
 (0)