Skip to content

Commit

Permalink
Release v0.6.0 (#61)
Browse files Browse the repository at this point in the history
* Bump version to 0.6.0

Signed-off-by: Thane Thomson <[email protected]>

* Prepare v0.6.0 release in changelog

Signed-off-by: Thane Thomson <[email protected]>

* Rebuild changelog

Signed-off-by: Thane Thomson <[email protected]>

* Fix readme for v0.6.0 release

Signed-off-by: Thane Thomson <[email protected]>

---------

Signed-off-by: Thane Thomson <[email protected]>
  • Loading branch information
thanethomson authored Mar 10, 2023
1 parent 711ee34 commit 416dcb1
Show file tree
Hide file tree
Showing 9 changed files with 66 additions and 8 deletions.
File renamed without changes.
13 changes: 13 additions & 0 deletions .changelog/v0.6.0/summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
*Mar 10, 2023*

This release introduces a few CLI-breaking changes in order to improve user
experience, so please review those breaking changes below carefully. In terms of
non-breaking changes, unclog v0.6.0 now supports the insertion of an arbitrary
prologue at the beginning of the changelog, in case you want some form of
preamble to your changelog.

Internally, the `structopt` package has been replaced by the latest version of
`clap` to build unclog's CLI, since it appears to have a better support
trajectory.

Also, special thanks to @thaligar for adding support for GitLab projects!
39 changes: 39 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,44 @@
# CHANGELOG

## v0.6.0

*Mar 10, 2023*

This release introduces a few CLI-breaking changes in order to improve user
experience, so please review those breaking changes below carefully. In terms of
non-breaking changes, unclog v0.6.0 now supports the insertion of an arbitrary
prologue at the beginning of the changelog, in case you want some form of
preamble to your changelog.

Internally, the `structopt` package has been replaced by the latest version of
`clap` to build unclog's CLI, since it appears to have a better support
trajectory.

Also, special thanks to @thaligar for adding support for GitLab projects!

### BREAKING CHANGES

- When calling `unclog build`, unclog now only builds
_released_ entries into the changelog. To build _all_ entries
(including unreleased ones), please use `unclog build --all`
([\#51](https://github.com/informalsystems/unclog/issues/51))
- When calling `unclog release`, the `--version` flag has been removed and
has become a mandatory positional argument, e.g. `unclog release v0.1.0`
([\#60](https://github.com/informalsystems/unclog/pull/60))

### DEPENDENCIES

- Switch from structopt to clap to remove dependency on now unmaintained
`ansi_term` package, and update other dependencies where possible
([\#49](https://github.com/informalsystems/unclog/pull/49))

### FEATURES

- Add support for GitLab repositories.
([#37](https://github.com/informalsystems/unclog/pull/37))
- Add support for a prologue to be inserted at the beginning of the changelog
([\#47](https://github.com/informalsystems/unclog/issues/47))

## v0.5.1

*27 January 2023*
Expand Down
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.5.1"
version = "0.6.0"
authors = ["Thane Thomson <[email protected]>"]
edition = "2021"
license = "Apache-2.0"
Expand Down
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ being able to tailor content to each audience: Git commit histories for our

## Requirements

- Rust v1.67+ with `cargo`
- Tested using Rust v1.68+ with `cargo`
- Git
- Your project is hosted on GitHub (for automatic changelog entry generation
from the CLI)
- Your project is hosted on GitHub or GitLab (for automatic changelog entry
generation from the CLI)

## Installation

Expand Down Expand Up @@ -170,11 +170,17 @@ resolved. If there's no issue, then reference the PR.

```bash
# Run from your project's directory to build your '.changelog' folder.
# Builds your CHANGELOG.md and writes it to stdout.
# Builds your CHANGELOG.md and writes it to stdout. Does not build any
# unreleased entries.
unclog build

# Only render unreleased changes (returns an error if none)
unclog build --unreleased
unclog build --unreleased-only
unclog build -u

# Build all entries, both released and unreleased.
unclog build --all
unclog build -a

# Save the output as your new CHANGELOG.md file.
# NOTE: All logging output goes to stderr.
Expand Down Expand Up @@ -316,12 +322,12 @@ as a library instead without the CLI:

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

## License

Copyright © 2021 Informal Systems
Copyright &copy; 2021- Informal Systems and contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use the files in this repository except in compliance with the License.
Expand Down

0 comments on commit 416dcb1

Please sign in to comment.