From bee8684b40793be708f1860ff9ba9d64b55561ce Mon Sep 17 00:00:00 2001 From: Norberto Goizueta Date: Mon, 4 Jul 2022 11:14:17 +0200 Subject: [PATCH] Update version tags to 2.0 --- .version.json | 2 +- docs/source/conf.py | 6 +++--- docs/source/content/contributing.md | 24 +++++++++++++++--------- sharpy/__init__.py | 2 +- 4 files changed, 20 insertions(+), 14 deletions(-) diff --git a/.version.json b/.version.json index f0d3d5195..5640fc512 100644 --- a/.version.json +++ b/.version.json @@ -1,6 +1,6 @@ { "schemaVersion": 1, "label": "release version", - "message": "1.3", + "message": "2.0", "color": "green" } diff --git a/docs/source/conf.py b/docs/source/conf.py index 57e4710fb..08e53a2c1 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -74,7 +74,7 @@ # 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 @@ -82,9 +82,9 @@ # 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. diff --git a/docs/source/content/contributing.md b/docs/source/content/contributing.md index 3ecbd5140..84a8457a5 100644 --- a/docs/source/content/contributing.md +++ b/docs/source/content/contributing.md @@ -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 --future-release ``` + +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 git push origin --tags -f ``` where `` 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 diff --git a/sharpy/__init__.py b/sharpy/__init__.py index 67bc602ab..f2dc0e400 100644 --- a/sharpy/__init__.py +++ b/sharpy/__init__.py @@ -1 +1 @@ -__version__ = "1.3.0" +__version__ = "2.0"