Skip to content

Commit

Permalink
Release process documentation syntax fixes. Don't use HTML tag syntax.
Browse files Browse the repository at this point in the history
  • Loading branch information
dhendriks committed Apr 30, 2024
1 parent 467b94e commit 94cbdc7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
To release a new release candidate or final release of MIDS, follow these steps:

* In GitHub, on the main page of MIDS, click in the right bar on *Create a new release*.
* Click *Choose a tag*, enter the new release name, e.g., `v0.9`, `v1.0-RC1`, or `v1.0.1-RC2`, and click *Create new tag: <tagname> on publish*, where *<tagname>* is the name of the tag.
* Click *Choose a tag*, enter the new release name, e.g., `v0.9`, `v1.0-RC1`, or `v1.0.1-RC2`, and click *Create new tag: [tagname] on publish*, where *[tagname]* is the name of the tag.
* For *Release title* type the same name as the tag name.
* Type a description of the release, based on the release notes for the release in the MIDS documentation.
See earlier releases for examples.
Expand All @@ -19,6 +19,6 @@ The GitHub action will then build the release, and attach the built website and
* Remove the `userguide` and `images` folders.
* Extract the new website archive into the branch.
* Add the changes by executing `git add -A .` in a shell.
* Commit the changes by executing `git commit -m "Replaced website by version <release_name>."` in a shell, replacing `<release_name>` by the name of the release.
* Commit the changes by executing `git commit -m "Replaced website by version [release_name]."` in a shell, replacing `[release_name]` by the name of the release.
* Push the changes by executing `git push` in a shell.
* It may take a few minutes before the website is deployed by GitHub and it becomes visible in a browser.

0 comments on commit 94cbdc7

Please sign in to comment.