From 3b768b3588998358818883ab3b1b6adf40745c7d Mon Sep 17 00:00:00 2001 From: kccwing <60852830+kccwing@users.noreply.github.com> Date: Wed, 18 Oct 2023 16:33:54 +0100 Subject: [PATCH 1/2] Update CHANGELOG.md for v2.2 --- CHANGELOG.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4c6604c0c..ee8733634 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,36 @@ # Changelog +## [2.2](https://github.com/imperialcollegelondon/sharpy/tree/2.2) (2023-10-18) + +[Full Changelog](https://github.com/imperialcollegelondon/sharpy/compare/2.1...2.2) + +**Implemented enhancements:** + +- Added environment for Apple Silicon \(ARM64\) [\#254](https://github.com/ImperialCollegeLondon/sharpy/pull/254) ([ben-l-p](https://github.com/ben-l-p)) +- New Fuselage Model plus Minor Improvements [\#249](https://github.com/ImperialCollegeLondon/sharpy/pull/249) ([sduess](https://github.com/sduess)) + +**Fixed bugs:** + +- fix polars concatenation in assembly of aeroinformation - develop [\#253](https://github.com/ImperialCollegeLondon/sharpy/pull/253) ([kccwing](https://github.com/kccwing)) +- fix polars concatenation in assembly of aeroinformation - main [\#252](https://github.com/ImperialCollegeLondon/sharpy/pull/252) ([kccwing](https://github.com/kccwing)) +- Minor bug fixes in aero util functions and save data postprocessor [\#247](https://github.com/ImperialCollegeLondon/sharpy/pull/247) ([sduess](https://github.com/sduess)) + +**Closed issues:** + +- Automated tests failed : UnicodeEncodeError: 'ascii' codec can't encode character '\xe9' in position 47: ordinal not in range\(128\) [\#245](https://github.com/ImperialCollegeLondon/sharpy/issues/245) +- Wrong key in settings for /cases/templates/flying\_wings.py [\#205](https://github.com/ImperialCollegeLondon/sharpy/issues/205) + +**Merged pull requests:** + +- merging develop into main for v2.2 [\#259](https://github.com/ImperialCollegeLondon/sharpy/pull/259) ([kccwing](https://github.com/kccwing)) +- fix \[docker\] use correct environment name in docker bashrc [\#257](https://github.com/ImperialCollegeLondon/sharpy/pull/257) ([sduess](https://github.com/sduess)) +- Update docker environment [\#255](https://github.com/ImperialCollegeLondon/sharpy/pull/255) ([sduess](https://github.com/sduess)) +- Update README.md [\#246](https://github.com/ImperialCollegeLondon/sharpy/pull/246) ([rafapalacios](https://github.com/rafapalacios)) +- bringing commits to main into develop [\#244](https://github.com/ImperialCollegeLondon/sharpy/pull/244) ([rafapalacios](https://github.com/rafapalacios)) +- Updates to plotutils.py and the cantilever\_wing demo [\#242](https://github.com/ImperialCollegeLondon/sharpy/pull/242) ([boltyboi](https://github.com/boltyboi)) +- Small additions to the installation guide. [\#241](https://github.com/ImperialCollegeLondon/sharpy/pull/241) ([boltyboi](https://github.com/boltyboi)) +- Tutorial for closed-Loop Simulation with SHARPy as a hardware-in-the-loop system [\#240](https://github.com/ImperialCollegeLondon/sharpy/pull/240) ([sduess](https://github.com/sduess)) + ## [2.1](https://github.com/imperialcollegelondon/sharpy/tree/2.1) (2023-05-31) [Full Changelog](https://github.com/imperialcollegelondon/sharpy/compare/2.0...2.1) From e9d0572ecbb89b2c23c78fc81f9e26dad53434b5 Mon Sep 17 00:00:00 2001 From: kccwing <60852830+kccwing@users.noreply.github.com> Date: Wed, 18 Oct 2023 16:36:10 +0100 Subject: [PATCH 2/2] Update contributing.md for v2.2 --- docs/source/content/contributing.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/source/content/contributing.md b/docs/source/content/contributing.md index b26212e3b..dbf5f1073 100644 --- a/docs/source/content/contributing.md +++ b/docs/source/content/contributing.md @@ -219,19 +219,21 @@ In the release candidate branch: 5. Merge release candidate branch into `main` branch In the `main` branch: - -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 -3. Create a release tag. IMPORTANT: ensure it is an *annotated* tag, otherwise the version and commit number in SHARPy will not display properly +1. 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`. + +2. 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 + ``` + +3. Push the changes to the `CHANGELOG.md` file 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 + +5. (Optional) Merge `main` branch back into `develop` branch