Skip to content

Commit

Permalink
Merge pull request #15 from tweag/release-0.2.0
Browse files Browse the repository at this point in the history
Release 0.2.0
  • Loading branch information
mergify[bot] committed Mar 26, 2020
2 parents 4305dfd + d6daf18 commit c6af1fe
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 1 deletion.
15 changes: 14 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,18 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).

## [Unreleased]

[Unreleased]: https://github.com/tweag/rules_sh/compare/v0.1.1...HEAD
[Unreleased]: https://github.com/tweag/rules_sh/compare/v0.2.0...HEAD

## [0.2.0] - 2020-03-26

[0.2.0]: https://github.com/tweag/rules_sh/compare/v0.1.1...v0.2.0

### Added

- Define appropriate `bzl_library` rules, so that rules that
depend `rules_sh` can generate `Stardoc` documentation.
See PR [#11][#11] and [Skydoc's deprecation][skydoc_deprecation]
for the motivation.

### Changed

Expand All @@ -31,6 +42,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).

[#14]: https://github.com/tweag/rules_sh/pull/14
[#13]: https://github.com/tweag/rules_sh/issues/13
[#11]: https://github.com/tweag/rules_sh/pull/11
[skydoc_deprecation]: https://github.com/bazelbuild/stardoc/blob/master/docs/skydoc_deprecation.md#starlark-dependencies

## [0.1.1] - 2019-11-13

Expand Down
19 changes: 19 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Maintenance instructions

## Cutting a new release

- Create a dedicated branch: `release-<version>` (e.g. `release-0.2.0`)
- Check the changes since the last release by
[comparing the heads](https://github.com/tweag/rules_sh/compare/v0.2.0...HEAD),
add anything relevant to `CHANGELOG.md`,
and update the version heading and unreleased heading in `CHANGELOG.md`.
* Open a PR for the new release, like
[#10](https://github.com/tweag/rules_sh/pull/14)
* When merged, create a tag of the form `v0.2.0` on the merge commit and push it:
`git push origin v0.2.0`
* Create the release on GitHub, selecting the tag created above.
* Add the relevant changelog section to the release notes.
* Obtain the sha256 for the release archive, by downloading the blob,
and calling `sha256sum` on it.
* Update the release notes with a workspace setup section for the new version,
such as [this example](https://github.com/tweag/rules_sh/releases/tag/v0.2.0)

0 comments on commit c6af1fe

Please sign in to comment.