Skip to content

Commit

Permalink
Release v0.4.0 (#16)
Browse files Browse the repository at this point in the history
* Bump version to v0.4.0 and build changelog

Signed-off-by: Thane Thomson <connect@thanethomson.com>

* Add GitHub action to release binaries

Signed-off-by: Thane Thomson <connect@thanethomson.com>
  • Loading branch information
thanethomson committed Sep 12, 2021
1 parent ab19fce commit 1f76e5e
Show file tree
Hide file tree
Showing 8 changed files with 72 additions and 4 deletions.
14 changes: 14 additions & 0 deletions .changelog/v0.4.0/summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
This version is a pretty major breaking change from the previous one. Some of
the highlights:

1. Entries can now be automatically generated from the CLI. This is only
available, however, for projects hosted on GitHub at the moment, since links
to issues/pull requests need to be automatically generated.
2. A configuration file (`.changelog/config.toml`) can now be specified that
allows you to override many of the default settings. See the `README.md` file
for more details.
3. Components/submodules are no longer automatically detected and must be
specified through the configuration file. This allows the greatest level of
flexibility for all kinds of projects instead of limiting `unclog` to just
Rust projects and implementing per-project-type component detection.

25 changes: 25 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
on:
release:
types: [created]

jobs:
release:
name: release ${{ matrix.target }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
target:
[
x86_64-unknown-linux-musl,
x86_64-apple-darwin,
x86_64-pc-windows-gnu,
]
steps:
- uses: actions/checkout@master
- name: Compile and release
uses: rust-build/rust-build.action@latest
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
RUSTTARGET: ${{ matrix.target }}
ARCHIVE_TYPES: ${{ matrix.archive }}
26 changes: 26 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
# CHANGELOG

## v0.4.0

This version is a pretty major breaking change from the previous one. Some of
the highlights:

1. Entries can now be automatically generated from the CLI. This is only
available, however, for projects hosted on GitHub at the moment, since links
to issues/pull requests need to be automatically generated.
2. A configuration file (`.changelog/config.toml`) can now be specified that
allows you to override many of the default settings. See the `README.md` file
for more details.
3. Components/submodules are no longer automatically detected and must be
specified through the configuration file. This allows the greatest level of
flexibility for all kinds of projects instead of limiting `unclog` to just
Rust projects and implementing per-project-type component detection.

### BREAKING CHANGES

- All positional CLI arguments have now been replaced with flagged ones. See
`unclog --help` and the project `README.md` for more details.
([#12](https://github.com/informalsystems/unclog/issues/12))
- Unreleased entries can now automatically be added to changelogs from the CLI.
This necessarily introduces configuration to be able to specify the project's
GitHub URL ([#13](https://github.com/informalsystems/unclog/issues/13))

## v0.3.0

This is a minor breaking release that now favours the use of hyphens (`-`) in
Expand Down Expand Up @@ -87,3 +112,4 @@ Basic features include:
* Automating the process of releasing unreleased features

See [README.md](README.md) for more details.

2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "unclog"
version = "0.3.0"
version = "0.4.0"
authors = ["Thane Thomson <thane@informal.systems>"]
edition = "2018"
license = "Apache-2.0"
Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,10 @@ being able to tailor content to each audience: Git commit histories for our

## Requirements

* Rust v1.54+ with `cargo`
- Rust v1.54+ with `cargo`
- Git
- Your project is hosted on GitHub (for automatic changelog entry generation
from the CLI)

## Installation

Expand Down Expand Up @@ -313,7 +316,7 @@ as a library instead without the CLI:

```toml
[dependencies]
unclog = { version = "0.3", default-features = false }
unclog = { version = "0.4", default-features = false }
```

## License
Expand Down

0 comments on commit 1f76e5e

Please sign in to comment.