Skip to content

Commit fb402e4

Browse files
committed
Release considerations
1 parent 9b0fe4f commit fb402e4

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
**/*.rs.bk
55
Cargo.lock
66
Cargo.toml
7+
Cargo.my.toml
78

89
# Created by https://www.gitignore.io/api/intellij+all
910

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,15 @@ even if not breaking changes by themselves, will only be included in the next ma
2323

2424
## Release process
2525

26+
The release process requires the workspace to be setup as per when performing Continuous Integration.
27+
Please follow these steps before you begin (shown for Unix):
28+
29+
1. Keep a copy of your existing `Cargo.toml` - `mv Cargo.toml Cargo.my.toml`. Note that `Cargo.my.toml`
30+
is ignored for the repository so it cannot be accidentally committed.
31+
2. Activate the CI workspace - `cp Cargo.ci.toml Cargo.toml`.
32+
33+
When finished releasing, copy or move your `Cargo.my.toml` back.
34+
2635
In order to release a new version of the HALs, the following steps need to be performed:
2736

2837
* **Changelog**: Update [the changelog](./CHANGELOG.md) to list all notable changes under the `Unreleased`

0 commit comments

Comments
 (0)