Skip to content

Commit

Permalink
Add version resolution section
Browse files Browse the repository at this point in the history
  • Loading branch information
wborn committed Dec 18, 2024
1 parent 0214eb0 commit e860137
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/user-guide/deploying/release-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@ If you have additional questions regarding this migration, we encourage you to r

## Local development practices

### Local artifacts

When developing a custom project you may also need to test changes you make to the manager code before your code gets merged.
You can test your local changes in a custom project by first publishing them to the local Maven repository using:

Expand All @@ -91,6 +93,16 @@ Note that the custom project build first resolves artifacts from `mavenLocal()`
So once you publish snapshot artifacts to your local Maven repository these will no longer be downloaded from the https://s01.oss.sonatype.org/content/repositories/snapshots repository.
To undo this, either comment the `mavenLocal()` repository or remove your local artifacts in `~/.m2/repository/io/openremote`.

### Version resolution

The manager build version is resolved based on tags and commits of the Git repository using the Gradle [axion-release-plugin](https://axion-release-plugin.readthedocs.io/en/latest/) plug-in.
For this to work correctly it is important your local Git repository has all published tags (i.e. use `git pull --tags`).

You can also configure Git to always fetch tags using:

* Per repository: `git config remote.origin.tagOpt --tags`
* Globally: `git config --global fetch.tagOpt --tags`

## Creating releases

The OpenRemote Manager and Android/iOS Console projects are released using a GitHub Actions "Release" workflow (release.yml).
Expand Down

0 comments on commit e860137

Please sign in to comment.