Skip to content

Commit

Permalink
Update changelog for release
Browse files Browse the repository at this point in the history
Include readme section explaining the release process.
  • Loading branch information
bisgardo committed Apr 29, 2024
1 parent bf57aeb commit 6dcb905
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.1.1] - 2024-04-29

### Added

- `AccountTransactionPayload.transfer(...)`: Add optional `memo` field for including a memo message in the transfer.
Expand Down
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,3 +111,24 @@ make fmt
It may also be [invoked directly from XCode](https://github.com/nicklockwood/SwiftFormat#trigger-plugin-from-xcode)
by right-clicking on package root (i.e. `concordium-swift-sdk`) in the Project Navigator pane.
The tool is then listed under "SwiftFormat" as "SwiftFormatPlugin" in the context menu for formatting the entire project.

## Release new version

To ship a new release for version `<version>`, push a commit that inserts the version and release date
to [`CHANGELOG.md`](./CHANGELOG.md), i.e., below `## [Unreleased]`, insert

```markdown
## [<version>] - <date>
```

Then simply push an *annotated* tag named `<version>` for this commit:

```shell
git tag -a <version>
```

Give the tag a message that explains briefly what changed.
This will trigger a [workflow](./.github/workflows/publish-release.yml) that publishes a GitHub release for the tag.
The release notes are constructed by concatenating the tag message with the changelog section

Note that the GitHub release is really used only for presentation - the actual release is defined by the tag.

0 comments on commit 6dcb905

Please sign in to comment.