Skip to content

Commit

Permalink
Merge pull request #28 from adybbroe/prepare-for-releasing
Browse files Browse the repository at this point in the history
Update readme file and add changelog and releasing guide
  • Loading branch information
adybbroe committed Jan 11, 2022
2 parents e9c0fff + 5a1d957 commit 01277a0
Show file tree
Hide file tree
Showing 5 changed files with 95 additions and 15 deletions.
40 changes: 25 additions & 15 deletions .github/workflows/ci.yaml
Expand Up @@ -10,8 +10,12 @@ jobs:
fail-fast: true
matrix:
os: ["ubuntu-latest", "macos-latest"]
python-version: ["3.7", "3.8"]
python-version: ["3.8", "3.9", "3.10"]
experimental: [false]
include:
- python-version: "3.10"
os: "ubuntu-latest"
experimental: true

env:
PYTHON_VERSION: ${{ matrix.python-version }}
Expand All @@ -38,21 +42,10 @@ jobs:
shell: bash -l {0}
run: |
python -m pip install \
-f https://7933911d6844c6c53a7d-47bd50c35cd79bd838daf386af554a83.ssl.cf2.rackcdn.com \
--no-deps --pre --upgrade \
matplotlib \
numpy \
pandas \
scipy; \
python -m pip install \
--no-deps --upgrade \
git+https://github.com/dask/dask \
git+https://github.com/dask/distributed \
git+https://github.com/zarr-developers/zarr \
git+https://github.com/Unidata/cftime \
git+https://github.com/mapbox/rasterio \
git+https://github.com/pydata/bottleneck \
git+https://github.com/pydata/xarray;
git+https://github.com/jswhit/pygrib \
git+https://github.com/pytroll/posttroll \
git+https://github.com/pytroll/trollsift;
- name: Install Pytroll-aapp-runner
shell: bash -l {0}
Expand All @@ -70,3 +63,20 @@ jobs:
flags: unittests
file: ./coverage.xml
env_vars: OS,PYTHON_VERSION,UNSTABLE
fail_ci_if_error: false

- name: Coveralls Parallel
uses: AndreMiras/coveralls-python-action@develop
with:
flag-name: run-${{ matrix.test_number }}
parallel: true
if: runner.os == 'Linux'

coveralls:
needs: [test]
runs-on: ubuntu-latest
steps:
- name: Coveralls Finished
uses: AndreMiras/coveralls-python-action@develop
with:
parallel-finished: true
25 changes: 25 additions & 0 deletions CHANGELOG.md
@@ -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.)

7 changes: 7 additions & 0 deletions README.md
@@ -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.
37 changes: 37 additions & 0 deletions RELEASING.md
@@ -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".


1 change: 1 addition & 0 deletions continuous_integration/environment.yaml
Expand Up @@ -4,6 +4,7 @@ channels:
dependencies:
- xarray
- dask
- pykdtree
- distributed
- cartopy
- matplotlib
Expand Down

0 comments on commit 01277a0

Please sign in to comment.