Skip to content

Commit

Permalink
Update release notes for v1.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
djhoese committed Aug 18, 2021
1 parent bc3b5cd commit 42ba82e
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 11 deletions.
19 changes: 19 additions & 0 deletions CHANGELOG.md
@@ -1,3 +1,22 @@
## Version 1.5.0 (2021/08/18)

### Issues Closed

* [Issue 48](https://github.com/pytroll/pycoast/issues/48) - Raster images without map projection
* [Issue 46](https://github.com/pytroll/pycoast/issues/46) - add_coastlines call is incorrect in documentation

In this release 2 issues were closed.

### Pull Requests Merged

#### Features added

* [PR 54](https://github.com/pytroll/pycoast/pull/54) - Add area and parameter hashing to overlay caching
* [PR 53](https://github.com/pytroll/pycoast/pull/53) - Switch to GitHub Actions for CI

In this release 2 pull requests were closed.


## Version 1.4.0 (2020/06/08)

### Issues Closed
Expand Down
41 changes: 30 additions & 11 deletions RELEASING.md
Expand Up @@ -5,24 +5,43 @@
3. run the unittests
4. run `loghub` and update the `CHANGELOG.md` file:

```
loghub pytroll/pycoast -u <username> -st v<last-tag> -plg bug "Bugs fixed" -plg enhancement "Features added" -plg documentation "Documentation changes"
```
```
loghub pytroll/pycoast --token $LOGHUB_GITHUB_TOKEN -st v<previous version> -plg bug "Bugs fixed" -plg enhancement "Features added" -plg documentation "Documentation changes" -plg backwards-incompatibility "Backward incompatible changes" -plg refactor "Refactoring"
```

Don't forget to commit!
This uses a `LOGHUB_GITHUB_TOKEN` environment variable. This must be created
on GitHub and it is recommended that you add it to your `.bashrc` or
`.bash_profile` or equivalent.

This command will create a CHANGELOG.temp file which need to be added
to the top of the CHANGLOG.md file. The same content is also printed
to terminal, so that can be copy-pasted, too. Remember to update also
the version number to the same given in step 5. Don't forget to commit
CHANGELOG.md!

5. Create a tag with the new version number, starting with a 'v', eg:

```
git tag -a v0.22.45 -m "Version 0.22.45"
```
```
git tag -a v<new version> -m "Version <new version>"
```

See [semver.org](http://semver.org/) on how to write a version number.
For example if the previous tag was `v0.9.0` and the new release is a
patch release, do:

```
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`

Make sure the new tag has been pushed.
6. push changes to github `git push --follow-tags`
7. Verify github action unittests passed.
8. Create a "Release" on GitHub by going to
https://github.com/pytroll/pycoast/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".
9. Verify the GitHub actions for deployment succeed and the release is on PyPI.

7. Verify travis tests passed and deployed sdist to PyPI

0 comments on commit 42ba82e

Please sign in to comment.