Releases

Project Releases

npm:

• Concerto
• Ergo
• Cicero
• Markdown Transform
• Markdown Editor
• Contract Editor
• Concerto UI
• Web Components

GitHub:

• Hyperledger Fabric Connector
• Corda App

Deployed:

• Template Library
• Models
• Template Studio
• Documentation

VSCode Marketplace:

• Cicero VSCode Extension

---

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.

1. You will need a GitHub Personal Access Token with public_repo permissions.
2. 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 and Type: Feature Request are not used, you should use Type: Enhancement instead.

3. 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

4. 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