Skip to content

Commit c6af1fe

Browse files
authored
Merge pull request #15 from tweag/release-0.2.0
Release 0.2.0
2 parents 4305dfd + d6daf18 commit c6af1fe

File tree

2 files changed

+33
-1
lines changed

2 files changed

+33
-1
lines changed

CHANGELOG.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,18 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
66

77
## [Unreleased]
88

9-
[Unreleased]: https://github.com/tweag/rules_sh/compare/v0.1.1...HEAD
9+
[Unreleased]: https://github.com/tweag/rules_sh/compare/v0.2.0...HEAD
10+
11+
## [0.2.0] - 2020-03-26
12+
13+
[0.2.0]: https://github.com/tweag/rules_sh/compare/v0.1.1...v0.2.0
14+
15+
### Added
16+
17+
- Define appropriate `bzl_library` rules, so that rules that
18+
depend `rules_sh` can generate `Stardoc` documentation.
19+
See PR [#11][#11] and [Skydoc's deprecation][skydoc_deprecation]
20+
for the motivation.
1021

1122
### Changed
1223

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

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

3548
## [0.1.1] - 2019-11-13
3649

MAINTAINERS.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Maintenance instructions
2+
3+
## Cutting a new release
4+
5+
- Create a dedicated branch: `release-<version>` (e.g. `release-0.2.0`)
6+
- Check the changes since the last release by
7+
[comparing the heads](https://github.com/tweag/rules_sh/compare/v0.2.0...HEAD),
8+
add anything relevant to `CHANGELOG.md`,
9+
and update the version heading and unreleased heading in `CHANGELOG.md`.
10+
* Open a PR for the new release, like
11+
[#10](https://github.com/tweag/rules_sh/pull/14)
12+
* When merged, create a tag of the form `v0.2.0` on the merge commit and push it:
13+
`git push origin v0.2.0`
14+
* Create the release on GitHub, selecting the tag created above.
15+
* Add the relevant changelog section to the release notes.
16+
* Obtain the sha256 for the release archive, by downloading the blob,
17+
and calling `sha256sum` on it.
18+
* Update the release notes with a workspace setup section for the new version,
19+
such as [this example](https://github.com/tweag/rules_sh/releases/tag/v0.2.0)

0 commit comments

Comments
 (0)