Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #28 from adybbroe/prepare-for-releasing
Update readme file and add changelog and releasing guide
- Loading branch information
Showing
5 changed files
with
95 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
## Version <RELEASE_VERSION> (2022/01/08) | ||
|
||
|
||
### Pull Requests Merged | ||
|
||
#### Bugs fixed | ||
|
||
* [PR 26](https://github.com/pytroll/pytroll-aapp-runner/pull/26) - Bugfix mhs calibration | ||
* [PR 21](https://github.com/pytroll/pytroll-aapp-runner/pull/21) - Bugfix: Nameservers list should be None on default | ||
|
||
#### Features added | ||
|
||
* [PR 26](https://github.com/pytroll/pytroll-aapp-runner/pull/26) - Bugfix mhs calibration | ||
* [PR 19](https://github.com/pytroll/pytroll-aapp-runner/pull/19) - Refactor aapp runner | ||
* [PR 18](https://github.com/pytroll/pytroll-aapp-runner/pull/18) - Add support for log config setup | ||
* [PR 17](https://github.com/pytroll/pytroll-aapp-runner/pull/17) - Adding unittests and minor refactoring | ||
* [PR 16](https://github.com/pytroll/pytroll-aapp-runner/pull/16) - Use setuptools scm versioning | ||
|
||
In this release 7 pull requests were closed. | ||
|
||
|
||
## Version 0.9.1 | ||
|
||
(There were no annotated tags before this one. Thus, no loghub history.) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,10 @@ | ||
pytroll-aapp-runner | ||
=================== | ||
|
||
[![Build status](https://github.com/pytroll/pytroll-aapp-runner/workflows/CI/badge.svg?branch=main)](https://github.com/pytroll/pytroll-aapp-runner/workflows/CI/badge.svg?branch=main) | ||
[![Coverage Status](https://coveralls.io/repos/github/pytroll/pytroll-aapp-runner/badge.svg?branch=main)](https://coveralls.io/github/pytroll/pytroll-aapp-runner?branch=main) | ||
|
||
|
||
A pytroll runner supporting real-time processing of Direct Readout or regional | ||
(RARS type) AVHRR and ATOVS data from level-0 to level-1 using the NWPSAF/AAPP | ||
package. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Releasing the aapp_runner | ||
|
||
prerequisites: `pip install setuptools twine` | ||
|
||
|
||
1. checkout main | ||
2. pull from repo | ||
3. run the unittests | ||
4. run `loghub` and update the `CHANGELOG.md` file: | ||
|
||
``` | ||
loghub pytroll/pytroll-aapp-runner --token <personal access token (see https://github.com/settings/tokens)> -st v<previous version> -plg bug "Bugs fixed" -plg enhancement "Features added" -plg documentation "Documentation changes" | ||
``` | ||
|
||
Don't forget to commit! | ||
|
||
5. Create a tag with the new version number, starting with a 'v', eg: | ||
|
||
``` | ||
git tag -a v0.9.1 -m "Version 0.9.1" | ||
``` | ||
|
||
See [semver.org](http://semver.org/) on how to write a version number. | ||
|
||
|
||
6. push changes to github `git push --follow-tags` | ||
|
||
7. Verify the Github actions unit tests passed | ||
|
||
8. Create a "Release" on GitHub by going to | ||
https://github.com/pytroll/pytroll-aapp-runner/releases and clicking "Draft a new | ||
release". On the next page enter the newly created tag in the "Tag version" | ||
field, "Version X.Y.Z" in the "Release title" field, and paste the markdown | ||
from the changelog (the portion under the version section header) in the | ||
"Describe this release" box. Finally click "Publish release". | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,6 +4,7 @@ channels: | |
dependencies: | ||
- xarray | ||
- dask | ||
- pykdtree | ||
- distributed | ||
- cartopy | ||
- matplotlib | ||
|