Commit f158499c authored by Mathias Chouet's avatar Mathias Chouet 🍝
Browse files

Update README

parent f3cfd0ae
......@@ -88,19 +88,25 @@ npm run viz
Use [semantic versioning](https://semver.org/).
**When releasing a Cassiopee (NgHyd) version along with a JaLHyd version, it's discouraged to execute release steps manually, see "Release Policy / Release Script" in [NgHyd's README.md](https://gitlab.irstea.fr/cassiopee/nghyd/blob/master/README.md)**
Before releasing a new stable version, one should complete the following files
- `CHANGELOG.md`
- `package.json` (update "version")
- `package.json` (update "version", or use `npm version`)
Every stable version should be tagged with both
- a tag stating compatibility with NgHyd, of the form `nghyd_X.Y.Z`
- the `stable` tag
The `stable` tag should be set **after** the NgHyd compatibility tag, so that `git describe` returns `stable` (latest tag).
The `stable` tag should be set **after** the NgHyd compatibility tag, so that `git describe` returns `stable` (latest tag). There should be **at least 1s** between the two tag commands, so that date sorting is not confused.
Here are the steps to follow for an example **4.5.0** version
```sh
npm version 4.5.0
# commit changes
git tag -fa nghyd_4.5.0
sleep 1
git tag -fa stable
git push --tags --force
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment