Skip to content

Commit ab61bc6

Browse files
committed
update documentation about release tag
1 parent ae5a0b8 commit ab61bc6

2 files changed

Lines changed: 5 additions & 2 deletions

File tree

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ I wish to thank the developers of these repositories, who generously provided
3737
guidance and time. This template has been developed in collaboration with
3838
[@enkatsu](https://github.com/enkatsu).
3939

40-
The example library was developed by Stig Møller Hansen ([@stixan](https://github.com/stixan)).
40+
The example library was developed by Stig Møller Hansen ([@stixan](https://github.com/stixan)).

docs/release.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,10 @@ Releasing your library on GitHub allows users to access known-working versions o
3939
5. Add a title and description for the release, highlighting key updates or changes.
4040
6. Click on **Publish release**.
4141

42-
This will trigger the GitHub workflow (`.github/workflows/release.yml`), which automatically create release artifacts—`*.txt`, `*.zip`, `*.pdex` files—and add them to the release.
42+
This will trigger the GitHub workflow (`.github/workflows/release.yml`), which automatically create release artifacts—`*.txt`, `*.zip`, `*.pdex` files—and add them to the release.
43+
44+
!!! Important
45+
The release tag created on Github will be propagated to the release artifacts, specifically the `prettyVersion` in the txt file and `library.properties` file in the zip. This overwrites the value input for `version` in the `build.gradle.kts` file.
4346

4447
_Note: By default, GitHub will also include compressed versions of your source code (e.g., `Source code (zip)` and `Source code (tar.gz)`)._
4548

0 commit comments

Comments
 (0)