Skip to content

Initial release #1

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.

Sign up for GitHub

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

Merged
CheckSanity merged 1 commit into from
Jun 21, 2026
Merged

Initial release #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
320 changes: 320 additions & 0 deletions .github/workflows/publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,320 @@
name: Release

on:
workflow_dispatch:
inputs:
mode:
description: "Prepare a release PR or publish the current main version."
required: true
default: prepare-release-pr
type: choice
options:
- prepare-release-pr
- publish-current
version:
description: "Release version as x.y.z. Leave empty in prepare mode to bump the root Gradle patch version."
required: false
type: string
pull_request:
types:
- closed
branches:
- main

permissions:
contents: read

concurrency:
group: release-${{ github.event_name }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: false

jobs:
prepare-release-pr:
name: Prepare release PR
runs-on: ubuntu-latest
if: ${{ github.event_name == 'workflow_dispatch' && inputs.mode == 'prepare-release-pr' }}
permissions:
contents: read
pull-requests: read

steps:
- name: Check out repository
uses: actions/checkout@v5
with:
fetch-depth: 0
persist-credentials: false

- name: Resolve release version
id: version
shell: bash
env:
REQUESTED_VERSION: ${{ inputs.version }}
run: |
set -euo pipefail

current_version="$(sed -nE 's/^val projectVersion = providers\.gradleProperty\("releaseVersion"\)\.orElse\("([^"]+)"\)\.get\(\)$/\1/p' build.gradle.kts)"
if [[ -z "$current_version" ]]; then
echo "Could not read root Gradle version from build.gradle.kts" >&2
exit 1
fi

if [[ -n "$REQUESTED_VERSION" ]]; then
if [[ ! "$REQUESTED_VERSION" =~ ^[0-9]+[.][0-9]+[.][0-9]+$ ]]; then
echo "Release version must use x.y.z format, found: $REQUESTED_VERSION" >&2
exit 1
fi
release_version="$REQUESTED_VERSION"
else
if [[ ! "$current_version" =~ ^([0-9]+)[.]([0-9]+)[.]([0-9]+)$ ]]; then
echo "Automatic version bump requires current root version to use x.y.z, found: $current_version" >&2
exit 1
fi
release_version="${BASH_REMATCH[1]}.${BASH_REMATCH[2]}.$((BASH_REMATCH[3] + 1))"
fi

if git rev-parse --verify --quiet "refs/tags/v${release_version}" >/dev/null; then
echo "Release tag already exists: v${release_version}" >&2
exit 1
fi

sed -i -E "s/orElse\\(\"[^\"]+\"\\)/orElse(\"${release_version}\")/" build.gradle.kts

echo "release_version=${release_version}" >> "$GITHUB_OUTPUT"
echo "branch=release/v${release_version}" >> "$GITHUB_OUTPUT"

- name: Build release notes
id: notes
shell: bash
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
RELEASE_VERSION: ${{ steps.version.outputs.release_version }}
run: |
set -euo pipefail

notes_file="$(mktemp)"
latest_tag="$(git tag -l 'v[0-9]*.[0-9]*.[0-9]*' --sort=-v:refname | head -n 1)"

{
echo "## Release v${RELEASE_VERSION}"
echo
echo "This PR updates the root Gradle release version to ${RELEASE_VERSION}."
echo
echo "## Changes since previous release"
echo
} > "$notes_file"

if [[ -n "$latest_tag" ]]; then
previous_release_date="$(git log -1 --format=%cI "$latest_tag")"
gh pr list \
--state merged \
--base main \
--limit 100 \
--search "merged:>${previous_release_date}" \
--json number,title,url,author,mergedAt \
--jq '. | sort_by(.mergedAt) | reverse | .[] | "- #\(.number) \(.title) by @\(.author.login) (\(.url))"' \
>> "$notes_file"
else
gh pr list \
--state merged \
--base main \
--limit 100 \
--json number,title,url,author,mergedAt \
--jq '. | sort_by(.mergedAt) | reverse | .[] | "- #\(.number) \(.title) by @\(.author.login) (\(.url))"' \
>> "$notes_file"
fi

if ! grep -q '^- #' "$notes_file"; then
echo "- No merged pull requests found since the previous release." >> "$notes_file"
fi

{
echo
echo "## Publish"
echo
echo "After this PR is merged, this workflow publishes dev.voir:optional:${RELEASE_VERSION}, pushes tag v${RELEASE_VERSION}, and creates a GitHub release using these notes."
} >> "$notes_file"

echo "path=${notes_file}" >> "$GITHUB_OUTPUT"

- name: Create release pull request
shell: bash
env:
GH_TOKEN: ${{ secrets.RELEASE_BOT_TOKEN }}
RELEASE_VERSION: ${{ steps.version.outputs.release_version }}
RELEASE_BRANCH: ${{ steps.version.outputs.branch }}
BODY_FILE: ${{ steps.notes.outputs.path }}
run: |
set -euo pipefail

if [[ -z "${GH_TOKEN:-}" ]]; then
echo "RELEASE_BOT_TOKEN is required so the release PR can trigger validation workflows." >&2
exit 1
fi

gh repo view "$GITHUB_REPOSITORY" >/dev/null

git config user.name "voir-release-bot"
git config user.email "voir-release-bot@users.noreply.github.com"
git remote set-url origin "https://x-access-token:${GH_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"

if git ls-remote --exit-code --heads origin "$RELEASE_BRANCH" >/dev/null 2>&1; then
git fetch origin "$RELEASE_BRANCH"
git checkout "$RELEASE_BRANCH"
else
git checkout -b "$RELEASE_BRANCH"
fi

git add build.gradle.kts
if git diff --cached --quiet; then
echo "Release branch already contains version ${RELEASE_VERSION}."
else
git commit -m "Release v${RELEASE_VERSION}"
fi
git push --set-upstream origin "$RELEASE_BRANCH"

existing_pr="$(gh pr list --repo "$GITHUB_REPOSITORY" --head "$RELEASE_BRANCH" --base main --json url --jq '.[0].url')"
if [[ -n "$existing_pr" ]]; then
echo "Release PR already exists: $existing_pr"
gh pr edit "$existing_pr" --title "Release v${RELEASE_VERSION}" --body-file "$BODY_FILE"
exit 0
fi

gh pr create \
--repo "$GITHUB_REPOSITORY" \
--base main \
--head "$RELEASE_BRANCH" \
--title "Release v${RELEASE_VERSION}" \
--body-file "$BODY_FILE"

publish:
name: Publish to Maven Central
runs-on: ubuntu-latest
if: >-
${{
(github.event_name == 'pull_request' &&
github.event.pull_request.merged == true &&
startsWith(github.event.pull_request.head.ref, 'release/v')) ||
(github.event_name == 'workflow_dispatch' && inputs.mode == 'publish-current')
}}
permissions:
contents: write
pull-requests: read
steps:
- name: Check out repository
uses: actions/checkout@v5
with:
ref: main
fetch-depth: 0

- name: Set up Java
uses: actions/setup-java@v5
with:
distribution: temurin
java-version: "21"
cache: gradle

- name: Resolve published version
id: version
shell: bash
run: |
set -euo pipefail

release_version="$(sed -nE 's/^val projectVersion = providers\.gradleProperty\("releaseVersion"\)\.orElse\("([^"]+)"\)\.get\(\)$/\1/p' build.gradle.kts)"
if [[ ! "$release_version" =~ ^[0-9]+[.][0-9]+[.][0-9]+$ ]]; then
echo "Root Gradle release version must use x.y.z format, found: ${release_version:-<empty>}" >&2
exit 1
fi

release_tag="v${release_version}"
if git ls-remote --tags origin "refs/tags/${release_tag}" | grep -q "refs/tags/${release_tag}$"; then
echo "Release tag already exists on origin: ${release_tag}" >&2
exit 1
fi

echo "release_version=${release_version}" >> "$GITHUB_OUTPUT"
echo "release_tag=${release_tag}" >> "$GITHUB_OUTPUT"

- name: Build release notes
id: notes
shell: bash
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
RELEASE_VERSION: ${{ steps.version.outputs.release_version }}
RELEASE_TAG: ${{ steps.version.outputs.release_tag }}
run: |
set -euo pipefail

notes_file="$(mktemp)"
if [[ "${GITHUB_EVENT_NAME}" == "pull_request" ]]; then
jq -r '.pull_request.body // ""' "$GITHUB_EVENT_PATH" > "$notes_file"
else
previous_tag="$(git tag -l 'v[0-9]*.[0-9]*.[0-9]*' --sort=-v:refname | head -n 1)"
{
echo "## Release ${RELEASE_TAG}"
echo
echo "Published from the current main branch."
echo
echo "## Changes since previous release"
echo
} > "$notes_file"

if [[ -n "$previous_tag" ]]; then
previous_release_date="$(git log -1 --format=%cI "$previous_tag")"
gh pr list \
--state merged \
--base main \
--limit 100 \
--search "merged:>${previous_release_date}" \
--json number,title,url,author,mergedAt \
--jq '. | sort_by(.mergedAt) | reverse | .[] | "- #\(.number) \(.title) by @\(.author.login) (\(.url))"' \
>> "$notes_file"
else
gh pr list \
--state merged \
--base main \
--limit 100 \
--json number,title,url,author,mergedAt \
--jq '. | sort_by(.mergedAt) | reverse | .[] | "- #\(.number) \(.title) by @\(.author.login) (\(.url))"' \
>> "$notes_file"
fi

if ! grep -q '^- #' "$notes_file"; then
echo "- No merged pull requests found since the previous release." >> "$notes_file"
fi
fi

echo "path=${notes_file}" >> "$GITHUB_OUTPUT"

- name: Publish to Maven Central
run: ./gradlew publishToMavenCentral -PreleaseVersion=${{ steps.version.outputs.release_version }} --no-configuration-cache
env:
ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.CENTRAL_USERNAME }}
ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.CENTRAL_PASSWORD }}
ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }}
ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.MAVEN_GPG_PASSPHRASE }}

- name: Create and push git tag
shell: bash
run: |
set -euo pipefail

release_tag="${{ steps.version.outputs.release_tag }}"

git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"

git tag -a "$release_tag" -m "Release $release_tag"
git push origin "$release_tag"

- name: Create GitHub release
shell: bash
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
RELEASE_TAG: ${{ steps.version.outputs.release_tag }}
NOTES_FILE: ${{ steps.notes.outputs.path }}
run: |
set -euo pipefail

gh release create "$RELEASE_TAG" \
--title "$RELEASE_TAG" \
--notes-file "$NOTES_FILE"
51 changes: 51 additions & 0 deletions .github/workflows/test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Verify the library

on:
pull_request:
branches:
- main

permissions:
contents: read

concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: true

jobs:
test:
name: Run tests
runs-on: macos-latest
if: ${{ !contains(github.event.pull_request.body || '', '[skip verify]') }}

steps:
- name: Checkout repository
uses: actions/checkout@v6

- name: Set up JDK 21
uses: actions/setup-java@v5
with:
distribution: temurin
java-version: "21"
cache: gradle

- name: Set up Gradle
uses: gradle/actions/setup-gradle@v5

- name: Build (all modules) with tests
run: ./gradlew --no-daemon clean build

- name: Publish test reports (always)
if: always()
uses: actions/upload-artifact@v6
with:
name: test-reports
path: |
**/build/test-results/**
**/build/reports/tests/**
if-no-files-found: ignore

- name: Publish build scans / reports (optional)
if: failure()
run: |
echo "Gradle build failed. See artifacts for reports."
Loading