Releases - accordproject/techdocs GitHub Wiki
Project Releases
npm:
GitHub:
- Hyperledger Fabric Connector
- Corda App
Deployed:
VSCode Marketplace:
Releasing
Releases are made manually by maintainers through GitHub. Version tags follow semantic-versioning conventions with a v
prefix, for example v1.2.3
.
Generating release notes from Pull Requests
A markdown changelog that includes the contributors and links to changes can be generated automatically through the lerna-changelog
tool.
- You will need a GitHub Personal Access Token with
public_repo
permissions. - Review all merged PRs since the last release to ensure that they are appropriately labelled with one of the following labels.
Type: Breaking Change ๐ฅ
Type: Enhancement โจ
Type: Bug ๐
Type: Chore ๐งผ
Type: Documentation ๐
Note that
Type: Styling
andType: Feature Request
are not used, you should useType: Enhancement
instead.
- Run the following command from the root folder of an up-to-date local clone of this repository to generate the markdown content.
GITHUB_AUTH=[YOUR_PERSONAL_ACCESS_TOKEN] npm run changelog:unreleased
- Copy the markdown output from the terminal to the GitHub release editor.
Release Notes Structure
### LABEL
- #<ISSUE_OR_PR>: Summary Title (@user)
- Specifics if needed here
- Any change which breaks previous versions
๐ฅ Breaking Change
- Any change which breaks previous versions
๐ Spec Compliance
- Changes to language specific specifications (i.e. unicode, parser, syntax)
๐ New Feature
- Added functionality which is noteworthy
๐ฐ New Command Line
- Added features to CLI of Ergo, Cicero, or Concerto
๐ฆ Ergo
- Support from lower in the stack from Ergo
๐ Standard Library
- Updates to the function library within Ergo
โ๏ธ Compiler
- Updates to the Ergo compiler
๐ Build
- Improved build process
๐ Bug Fix
- Corrections to issues in production source code
โ๏ธ Dependencies
- Upgrade to dependencies
๐ก๏ธSecurity
- Fix to vulnerability or improved code safety
๐โโ Performance
- Improvements to code efficiency
๐ Polish
- Styling updates or refactoring the structure of source code
๐ Documentation
- Additions or edits to docs for accessibility to information or guides
๐ Internal
- Updates to factors which concern contributors and maintainers (i.e. tests or licensing)
๐ Regression
- A rollback of code, usually a mistake that was merged in