Skip to content

use release tag name for prettyVersion #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed
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
4 changes: 3 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ name: Release

on:
push:
branches:
- release-version-in-txt
tags:
- 'v*'

Expand All @@ -25,7 +27,7 @@ jobs:
gradle-version: 8.5
- name: Build with Gradle
id: build
run: gradle buildReleaseArtifacts
run: gradle -Pversion=v-tag-manual buildReleaseArtifacts
- name: Release
uses: softprops/action-gh-release@v2
with:
Expand Down
5 changes: 4 additions & 1 deletion docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,10 @@ Releasing your library on GitHub allows users to access known-working versions o
5. Add a title and description for the release, highlighting key updates or changes.
6. Click on **Publish release**.

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

!!! Important
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.

!!! Note
By default, GitHub will also include compressed versions of your source code (e.g., `Source code (zip)` and `Source code (tar.gz)`).
Expand Down
Loading