Skip to content

Commit 2cf6124

Browse files
committed
refactor(devbook): rename upgrade version doc to bump-versions
To better reflect the fact that not only rust crates are updated but also js packages.
1 parent 3fefbac commit 2cf6124

File tree

3 files changed

+12
-13
lines changed

3 files changed

+12
-13
lines changed

docs/devbook/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This page gathers the available guides and tools for Mithril nodes developers.
44

55
# Guides
66

7-
| Operation | Location | Description |
8-
| --------------------------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
9-
| **Upgrade crates and openapi versions** | [upgrade-crates-and-openapi-versions](./upgrade-crates-and-openapi-versions/README.md) | Script to easily upgrade crates and openapi versions before merging a pull request |
10-
| **Upgrade the repository dependencies** | [upgrade-repository-dependencies](./upgrade-repository-dependencies/README.md) | Upgrade the project's dependencies in the repository |
7+
| Operation | Location | Description |
8+
| --------------------------------------- | ------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- |
9+
| **Bump versions** | [bump-versions](bump-versions/README.md) | Script to easily bump crates, js packages, and openapi versions before merging a pull request |
10+
| **Upgrade the repository dependencies** | [upgrade-repository-dependencies](./upgrade-repository-dependencies/README.md) | Upgrade the project's dependencies in the repository |

docs/devbook/upgrade-crates-and-openapi-versions/README.md renamed to docs/devbook/bump-versions/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Upgrade the crates and openapi versions before merging a pull request
1+
# Bump the crates, js packages, and openapi versions before merging a pull request
22

33
## Introduction
44

5-
This devbook provides a script that allows to automatically upgrade the crates and Open API versions in the project.
5+
This devbook provides a script that allows to automatically bump the crates, js packages, and Open API versions in the project.
66

7-
Only the crates and Open API specifications with changes on the branch compared to `origin/main` are upgraded.
7+
Only the crates, js packages, and Open API specifications with changes on the branch compared to `origin/main` are bumped.
88

99
## Prerequisites
1010

@@ -24,7 +24,7 @@ cargo install cargo-get
2424
Just run the script without argument, by default no changes are made to the project.
2525

2626
```shell
27-
. ./docs/devbook/upgrade-crates-and-openapi-versions/upgrade_crates_and_openapi_versions.sh
27+
. ./docs/devbook/bump-versions/bump_versions.sh
2828
```
2929

3030
### Run
@@ -34,18 +34,18 @@ Just run the script without argument, by default no changes are made to the proj
3434
>
3535
> This means that running the script more than once will bump the versions again.
3636
37-
Run the script with the `--run` argument to bump the crates and openapi versions.
37+
Run the script with the `--run` argument to bump the crates, js packages, and openapi versions.
3838

3939
The script will output a preformatted commit message that can be used to create a commit when it completes.
4040

4141
```shell
42-
. ./docs/devbook/upgrade-crates-and-openapi-versions/upgrade_crates_and_openapi_versions.sh --run
42+
. ./docs/devbook/bump-versions/bump_versions.sh --run
4343
```
4444

4545
If you want the script to do the commit for you, add the `--commit` argument.
4646

4747
```shell
48-
. ./docs/devbook/upgrade-crates-and-openapi-versions/upgrade_crates_and_openapi_versions.sh --run --commit
48+
. ./docs/devbook/bump-versions/bump_versions.sh --run --commit
4949
```
5050

5151
> [!NOTE]
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ set +a -u -o pipefail
33

44
if [[ "${TRACE-0}" == "1" ]]; then set -o xtrace; fi
55

6-
# Check crates modify against `origin/main` and update their version.
7-
# The openapi.yam is also verified and updated if necessary.
6+
# Check crates, js packages, and openapi changes against `origin/main` and update their version.
87
# At the end of the script, the commit message to used is displayed.
98

109
# Usage:

0 commit comments

Comments
 (0)