|
1 | 1 | # Releasing metoppy |
2 | 2 |
|
3 | | -1. checkout main branch |
4 | | -2. pull from repo |
5 | | -3. run the unittests |
6 | | -4. Update the `CHANGELOG.md` file. |
7 | | -5. Create a tag with the new version number, starting with a 'v', eg: |
| 3 | +0. Make sure the code references the correct new version you want in the pyproject.yaml and in the __init__.py |
| 4 | +1. checkout main branch: `git checkout main` |
| 5 | +2. pull from repo: `git pull` |
| 6 | +3. run the unittests with pytest. |
| 7 | +4. Update the `CHANGELOG.md` file using vim or similar. (`source REPO_URL="https://github.com/eumetsat/MetopPy"`, then `git log --pretty=format:"- %s ([%h]($REPO_URL/commit/%H)) (%an, %ad)" --date=short > CHANGELOG_UNRELEASED.md` You can use `git log $(git describe --tags --abbrev=0)..HEAD --pretty=format:"- %s (%h)" > CHANGELOG_UNRELEASED.md` to generate the list of commits and PR used also) |
| 8 | +``` |
| 9 | +### Bug Fixes |
| 10 | +* Force ansible roles download when new versions exist ([#22](https://github.com/ewcloud/ewccli/pull/22)) ([#3](https://github.com/ewcloud/ewccli/issues/3)) ([9263391](https://github.com/ewcloud/ewccli/commit/92633917a71d3cf5cf6aea23f4fef83e052f3f92)) |
| 11 | +* Remove dependency not used ([#19](https://github.com/ewcloud/ewccli/pull/19)) ([#6](https://github.com/ewcloud/ewccli/issues/6)) ([d44135b](https://github.com/ewcloud/ewccli/commit/d44135bbaf8864722dc324f201d0ad4f61c5a89d)) |
| 12 | +``` |
| 13 | +5. git add CHANGELOG.md |
| 14 | +6. git commit --cleanup=whitespace # commit title and body to be added. Example below: |
| 15 | +``` |
| 16 | +chore: 0.2.0 [skip ci] |
| 17 | +
|
| 18 | +# [0.2.0](https://github.com/ewcloud/ewccli/compare/0.1.1...0.2.0) (2025-10-14) |
| 19 | +
|
| 20 | +### Features |
| 21 | +
|
| 22 | +- feat: Use defaultSecurityGroups and checkDNS from items index [b77b43b](https://github.com/ewcloud/ewccli/commit/b77b43b3916438e476606b58b965712bc08a407d) |
| 23 | +- feat: Introduce checkDNS for items ([#29](https://github.com/ewcloud/ewccli/pull/29)) [7f98a6a](https://github.com/ewcloud/ewccli/commit/7f98a6ab9dcb96825f259663aac8445daaee1b1d) |
| 24 | +- feat: bump versions ([#26](https://github.com/ewcloud/ewccli/pull/26)) [78adb02](https://github.com/ewcloud/ewccli/commit/78adb024771c7a3bc8da83c1325c51a171259557) |
| 25 | +
|
| 26 | +### Bug Fixes |
| 27 | +- fix: Set DNS check to 15 minutes [9f24e2f](https://github.com/ewcloud/ewccli/commit/9f24e2f5a7584db980eb0863fc9ab57521536151) |
| 28 | +- fix: ewc hub list command item name should show all name always ([#25](https://github.com/ewcloud/ewccli/pull/25)) [e4869fc](https://github.com/ewcloud/ewccli/commit/e4869fcd4757910160ec68894417fae76ca622b5) |
| 29 | +``` |
| 30 | +7. Create a tag with the new version number, eg: |
8 | 31 |
|
9 | 32 | ``` |
10 | | - git tag -a v<new version> -m "Version <new version>" |
| 33 | + git tag -a <new version> -m "Version <new version>" |
11 | 34 | ``` |
12 | 35 |
|
13 | | - For example if the previous tag was `v0.9.0` and the new release is a |
| 36 | + For example if the previous tag was `0.1.1` and the new release is a |
14 | 37 | patch release, do: |
15 | 38 |
|
16 | 39 | ``` |
17 | | - git tag -a v0.9.1 -m "Version 0.9.1" |
| 40 | + git tag -a 0.1.1 -m "Version 0.1.1" |
18 | 41 | ``` |
19 | 42 |
|
20 | 43 | See [semver.org](http://semver.org/) on how to write a version number. |
21 | 44 |
|
22 | | - |
23 | | -6. push changes to github `git push --follow-tags` |
24 | | -7. Verify github action unittests passed. |
25 | | -8. Create a "Release" on GitHub by going to |
| 45 | +8. Push commits `git push` |
| 46 | +9. Push tags to github `git push --follow-tags` |
| 47 | +10. Verify github action unittests passed. |
| 48 | +11. Create a "Release" on GitHub by going to |
26 | 49 | https://github.com/eumetsat/MetopDatasets.jl/releases and clicking "Draft a new release". |
27 | 50 | On the next page enter the newly created tag in the "Tag version" field, |
28 | 51 | "Version X.Y.Z" in the "Release title" field, and paste the markdown from |
29 | 52 | the changelog (the portion under the version section header) in the |
30 | 53 | "Describe this release" box. Finally click "Publish release". |
31 | 54 |
|
32 | | -9. Now you can start the process to release on PyPI (only admins) |
| 55 | +12. Now you can start the process to release on PyPI (only admins) |
33 | 56 |
|
34 | | -9.1 Build package |
| 57 | +12.1 Build package |
35 | 58 |
|
36 | 59 | Now generate the distribution. To build the package, use PyPA build. |
37 | 60 |
|
@@ -62,4 +85,4 @@ To upload your package to PyPI, use Twine: |
62 | 85 | ```bash |
63 | 86 | twine upload dist/* |
64 | 87 | ``` |
65 | | -You'll be prompted for your PyPI username & password. |
| 88 | +You'll be prompted for your PyPI username & password. |
0 commit comments