Skip to content

Commit

Permalink
Update version tags to 2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ngoiz committed Jul 4, 2022
1 parent 4f68b5e commit bee8684
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .version.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"schemaVersion": 1,
"label": "release version",
"message": "1.3",
"message": "2.0",
"color": "green"
}
6 changes: 3 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,17 +74,17 @@

# General information about the project.
project = 'SHARPy'
copyright = '2021, LoCA Lab ICL'
copyright = '2022, LoCA Lab ICL'
author = 'Aeroelastics Lab, Imperial College London'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.3'
version = '2.0'
# The full version, including alpha/beta/rc tags.
release = '1.3'
release = '2.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
24 changes: 15 additions & 9 deletions docs/source/content/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,28 +204,34 @@ be found [here](https://chris.beams.io/posts/git-commit/).
# For developers:
## Releasing a new version
## Releasing a new SHARPy version
In the release candidate branch:
* Update the version number in the docs configuration file `docs/conf.py`
* Update `version.json` file
* Update version in `sharpy/__init__.py` file
* Commit, push and wait for tests to pass
* Merge release candidate branch into `master` branch
1. Update the version number in the docs configuration file `docs/source/conf.py`. Update variables `version` and `release`
2. Update `version.json` file
3. Update version in `sharpy/__init__.py` file
4. Commit, push and wait for tests to pass
5. Merge release candidate branch into `master` branch
In the `master` branch:
* Run the [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator) tool locally with the following parameters:
1. Run the [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator) tool locally with the following parameters:
```
github_changelog_generator -u imperialcollegelondon -p sharpy -t <your_github_token> --future-release <new_release_version>
```
2. Push the changes to the `CHANGELOG.md` file
* Create a release tag. IMPORTANT: ensure it is an *annotated* tag, otherwise the version and commit number in SHARPy will not display properly
3. Create a release tag. IMPORTANT: ensure it is an *annotated* tag, otherwise the version and commit number in SHARPy will not display properly
```
git tag -a <tagname>
git push origin --tags -f
```
where `<tagname>` is something like `2.0`.
* Create the GitHub release, choosing the newly created tag from the dropdown menu. Do not create a tag from the dropdown menu directly because it will not be an annotated tag
4. Create the GitHub release, choosing the newly created tag from the dropdown menu. Do not create a tag from the dropdown menu directly because it will not be an annotated tag
2 changes: 1 addition & 1 deletion sharpy/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "1.3.0"
__version__ = "2.0"

0 comments on commit bee8684

Please sign in to comment.