Skip to content

Commit

Permalink
Remove changelog requirement for release. (#100)
Browse files Browse the repository at this point in the history
Since github manages changelogs now, there is no need for a manual changelog.
Other repositories have also shifted to this technique.

Signed-off-by: David Enyeart <[email protected]>
  • Loading branch information
denyeart authored Mar 1, 2023
1 parent c15d670 commit f03e626
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 21 deletions.
17 changes: 0 additions & 17 deletions .release/changelog.sh

This file was deleted.

10 changes: 9 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# fabric-contract-api-go Changelog

fabric-contract-api-go [releases](https://github.com/hyperledger/fabric-contract-api-go/releases) each have a changelog maintained by GitHub.

# Early fabric-contract-api-go release Changelogs

Early fabric-contract-api-go releases prior to v1.2.1 copied commit history into the changelog file below.

## v1.2.0
Fri 23 Sep 2022 14:22:09 BST

Expand Down Expand Up @@ -61,4 +69,4 @@ Wed 5 Feb 2020 16:17:56 GMT
* [04f3921](https://github.com/hyperledger/fabric-contract-api-go/commit/04f3921) Add changelog, script and check (#5)
* [0e2d581](https://github.com/hyperledger/fabric-contract-api-go/commit/0e2d581) Make unit tests verbose and fix godog path (#4)
* [a545e98](https://github.com/hyperledger/fabric-contract-api-go/commit/a545e98) Fix gofmt issues (#3)
* [f9df77e](https://github.com/hyperledger/fabric-contract-api-go/commit/f9df77e) Initial commit
* [f9df77e](https://github.com/hyperledger/fabric-contract-api-go/commit/f9df77e) Initial commit
4 changes: 1 addition & 3 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

Before releasing ensure that you have:
- Decided on a release tag. The repo uses a 3 number semantic versioning system and therefore the tag should be of the form v.X.X.X e.g. v1.0.0. This value will be known in the rest of this document as `<RELEASE_TAG>`.
- Run `.release/changelog.sh <PREVIOUS_RELEASE_TAG> <RELEASE_TAG>` to update CHANGELOG.md to contain all commits since the previous tag. Running without the previous release tag will get all commits.
- Commit the updated changelog via PR with commit message "Preparing for release `<RELEASE_TAG>`"

Releasing:
- Go to: https://github.com/hyperledger/fabric-contract-api-go/releases
Expand All @@ -13,4 +11,4 @@ Releasing:
- Add to the large textarea the release notes. These should consist of:
- Include section called "Release Notes" containing the high-level view of changes made in the version that are of note.
- (Optional) Include a section called "Migration Notes" detailing "gotchas" for the user of migrating to the new version.
- (Optional) Include a section called "Bug Fixes" detailing important bug fixes in the version. Should be listed as bullet points with a link to the JIRA for that bug.
- (Optional) Include a section called "Bug Fixes" detailing important bug fixes in the version.

0 comments on commit f03e626

Please sign in to comment.