Skip to content

Commit

Permalink
monica_reminder v0.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Ian2020 committed Jan 25, 2023
1 parent f92d661 commit 1eae691
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 3 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.0.1 - 2023-01-25](https://github.com/Ian2020/monica_reminder/releases/tag/v0.0.1)

### Added

* README: instructions on installing with bin and example systemd timer and
Expand Down
47 changes: 44 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,10 +147,51 @@ executed, is also released under the [Creative Commons Attribution ShareAlike

### Releasing

This is a stub for now.
In the following `<VERSION>` should be replaced with the new version number
prepended with a `v`, e.g. `v1.0.0`.

* Include `monica_reminder` as a release asset so that it can be installed
by [bin](https://github.com/marcosnils/bin).
* Update [CHANGELOG.md](CHANGELOG.md)

The 'Unreleased' entry at the top of `CHANGELOG.md` should already
enumerate the significant updates to the new version. If not update it, retitle
it with the version number and date, then create a new empty 'Unreleased' entry.
At the bottom add a reference to the release tag.

* Update copyright years if applicable

Run `copier update` and update the copyright year. You can use a range here so
long as you have a statement explaining this use in your README. You may want
to re-apply your copyright headers to files now and check REUSE compliance to
ensure all updated.

* Commit, tag and push

Commit these changes (including the `CHANGELOG.md` changes) with the message
`monica_reminder <VERSION>`

Create a new annotated tag with:

```bash
git tag -a -e -F <(sed "s/^#\+ //g" CHANGELOG.md) <VERSION>
```

Include the `CHANGELOG.md` notes corresponding to the new version as the
tag annotation, except the first line should be:

```text
monica_reminder <VERSION> - YYYY-MM-DD
```

Push the new version commit and tag to GitLab via the following:

```bash
git push --follow-tags
```

* Create a GitHub release - for now we're doing this through the website.
* Select the tag you just pushed
* Include `monica_reminder` as a release asset so that it can be installed
by [bin](https://github.com/marcosnils/bin).
## Vulnerability Reporting or Security Issues
Expand Down

0 comments on commit 1eae691

Please sign in to comment.