Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ For users
- [Code samples](./tutorials/README.md)

For developers
- [Release management](./RELEASE-MANAGEMENT.md)
- Core concepts *\[coming soon\]*
- Contribution guide *\[coming soon\]*

Expand Down
36 changes: 36 additions & 0 deletions RELEASE-MANAGEMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Release management

This guide describes the steps required to release a new version of **LCA as Code (LCAAC)**.

## Prerequisites
- You have the latest version of the main branch.
- You have the necessary permissions to tag releases and trigger workflows.
- You have access to the repository homebrew-lcaac for package updates.

## Release Steps
1. **Update the version number**

Update the version consistently across the following files:
- `resources/META-INF/lcaac.properties`
- `gradle.properties`
- `README.md` → update the installation script from source (around line 31)

⚠️ Double-check that all version numbers match.

2.**Merge your pull request**

Ensure your changes are merged into the `main` branch.
3.**Create a Git tag**

Add a tag to the main branch (replace `X.Y.Z` with the new version number).

Use semantic versioning (`MAJOR.MINOR.PATCH`) format
```
git tag vX.Y.Z
git push origin vX.Y.Z
```
This will trigger the publication workflow that builds and publishes the release artifacts.

## Post-Release Steps
- Update Homebrew and Nix formulas
To make the new version available via brew and nix by following the instructions in the `kleis-technology/homebrew-lcaac` repository.