Skip to content

Commit 7864ec7

Browse files
author
Hans
authored
docs: update release process to remove rust agent, and be fish friendly (#917)
1 parent ff6bdea commit 7864ec7

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

docs/process/release.adoc

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -234,17 +234,24 @@ rm -rf hello_world
234234
----
235235
nix-shell
236236
----
237+
. Set the new version in a temporary environment variable.
238+
+
239+
For example, replace `<n.n.n>` with a specific version number:
240+
+
241+
[source, nix-shell]
242+
----
243+
export NEW_DFX_VERSION=<n.n.n>
244+
----
237245
. Create a new branch for your changes by running the following commands:
238246
+
239247
[source, nix-shell]
240248
----
241-
git switch -c <YOUR_NAME>/<BRANCH-FOR-NEW_DFX_VERSION>
249+
git switch -c $USER/release-$NEW_DFX_VERSION
242250
----
243251
. Update the `version` field for the following files:
244252
+
245253
....
246254
`src/dfx/Cargo.toml`
247-
`src/agent/rust/Cargo.toml`
248255
`src/ic_identity_manager/Cargo.toml`
249256
....
250257
. Apply these changes to `Cargo.lock` by running the following command:
@@ -253,19 +260,11 @@ git switch -c <YOUR_NAME>/<BRANCH-FOR-NEW_DFX_VERSION>
253260
----
254261
cargo build
255262
----
256-
. Set the new version in a temporary environment variable.
257-
+
258-
For example, replace `<n.n.n>` with a specific version number:
259-
+
260-
[source, nix-shell]
261-
----
262-
export NEW_DFX_VERSION=<n.n.n>
263-
----
264263
. Update the `@dfinity/agent` JavaScript package by running the following command:
265264
+
266265
[source, nix-shell]
267266
----
268-
cd src/agent/javascript/ && npm version ${NEW_DFX_VERSION}
267+
cd src/agent/javascript/ && npm version $NEW_DFX_VERSION
269268
----
270269
. Navigate back to the root of sdk repo by running the following command:
271270
+
@@ -277,7 +276,7 @@ cd ../../..
277276
+
278277
[source, nix-shell]
279278
----
280-
cd src/bootstrap/ && npm version ${NEW_DFX_VERSION}
279+
cd src/bootstrap/ && npm version $NEW_DFX_VERSION
281280
----
282281
. Navigate back to the root of sdk repo by running the following command:
283282
+
@@ -313,8 +312,8 @@ For example:
313312
[source, bash]
314313
----
315314
git add --all
316-
git commit --signoff --message "chore: Release `NEW_DFX_VERSION`"
317-
git push origin <YOUR_NAME>/<BRANCH-FOR-NEW_DFX_VERSION>
315+
git commit --signoff --message "chore: Release $NEW_DFX_VERSION"
316+
git push origin $USER/release-$NEW_DFX_VERSION
318317
----
319318
. After pushing, click the link in the console to go to your new branch in GitHub, then click *Create Pull Request*.
320319
. Have the validator review and approve the PR.
@@ -348,7 +347,7 @@ git pull origin master --ff-only
348347
+
349348
[source, bash]
350349
----
351-
git tag --annotate ${NEW_DFX_VERSION} --message "Release: `${NEW_DFX_VERSION}`"
350+
git tag --annotate $NEW_DFX_VERSION --message "Release: $NEW_DFX_VERSION"
352351
----
353352
. Verify the tag points to the correct version and includes annotation by running the following commands:
354353
+
@@ -361,7 +360,7 @@ git describe --always
361360
+
362361
[source, bash]
363362
----
364-
git push origin ${NEW_DFX_VERSION}
363+
git push origin $NEW_DFX_VERSION
365364
----
366365
+
367366
CI will only publish `dfx` from the latest commit from the `stable` branch when that commit is tagged with a version.

0 commit comments

Comments
 (0)