Skip to content

Commit 9019074

Browse files
snicollsnicoll
committed
Add workflow to release on Maven Central
This commit adds a standard GHA workflow to perform a release, including syncing with Maven Central using s01.oss.sonatype.org. The release workflow kicks off based on tag that matches `vX.Y.Z` and perform the following: * Build the project * Stage the bits to repo.spring.io * Move the staging bits to Maven Central * Promote the bits to repo.spring.io/release * Generate a changelog using the issues matching the version Closes gh-1812
1 parent 4022e4a commit 9019074

File tree

6 files changed

+217
-0
lines changed

6 files changed

+217
-0
lines changed

‎.github/actions/await-http-resource/action.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Await HTTP Resource
2+
description: 'Waits for an HTTP resource to be available (a HEAD request succeeds)'
3+
inputs:
4+
url:
5+
description: 'URL of the resource to await'
6+
required: true
7+
runs:
8+
using: composite
9+
steps:
10+
- name: Await HTTP resource
11+
shell: bash
12+
run: |
13+
url=${{ inputs.url }}
14+
echo "Waiting for $url"
15+
until curl --fail --head --silent ${{ inputs.url }} > /dev/null
16+
do
17+
echo "."
18+
sleep 60
19+
done
20+
echo "$url is available"

‎.github/actions/create-github-release/action.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Create GitHub Release
2+
description: 'Create the release on GitHub with a changelog'
3+
inputs:
4+
milestone:
5+
description: 'Name of the GitHub milestone for which a release will be created'
6+
required: true
7+
pre-release:
8+
description: 'Whether the release is a pre-release (a milestone or release candidate)'
9+
required: false
10+
default: 'false'
11+
token:
12+
description: 'Token to use for authentication with GitHub'
13+
required: true
14+
runs:
15+
using: composite
16+
steps:
17+
- name: Generate Changelog
18+
uses: spring-io/github-changelog-generator@185319ad7eaa75b0e8e72e4b6db19c8b2cb8c4c1 #v0.0.11
19+
with:
20+
config-file: .github/actions/create-github-release/changelog-generator.yml
21+
milestone: ${{ inputs.milestone }}
22+
token: ${{ inputs.token }}
23+
- name: Create GitHub Release
24+
shell: bash
25+
env:
26+
GITHUB_TOKEN: ${{ inputs.token }}
27+
run: gh release create ${{ format('v{0}', inputs.milestone) }} --notes-file changelog.md ${{ inputs.pre-release == 'true' && '--prerelease' || '' }}

‎.github/actions/create-github-release/changelog-generator.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
changelog:
2+
repository: spring-projects/spring-webflow
3+
sections:
4+
- title: ":star: New Features"
5+
labels:
6+
- "type: enhancement"
7+
- title: ":lady_beetle: Bug Fixes"
8+
labels:
9+
- "type: bug"
10+
- "type: regression"
11+
- title: ":notebook_with_decorative_cover: Documentation"
12+
labels:
13+
- "type: documentation"
14+
- title: ":hammer: Dependency Upgrades"
15+
sort: "title"
16+
labels:
17+
- "type: dependency-upgrade"
18+
contributors:
19+
exclude:
20+
names:
21+
- "bclozel"
22+
- "rstoyanchev"
23+
- "snicoll"

‎.github/actions/sync-to-maven-central/action.yml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Sync to Maven Central
2+
description: 'Syncs a release to Maven Central and waits for it to be available for use'
3+
inputs:
4+
jfrog-cli-config-token:
5+
description: 'Config token for the JFrog CLI'
6+
required: true
7+
ossrh-s01-staging-profile:
8+
description: 'Staging profile to use when syncing to Central'
9+
required: true
10+
ossrh-s01-token-password:
11+
description: 'Password for authentication with s01.oss.sonatype.org'
12+
required: true
13+
ossrh-s01-token-username:
14+
description: 'Username for authentication with s01.oss.sonatype.org'
15+
required: true
16+
spring-webflow-version:
17+
description: 'Version of Spring Webflow that is being synced to Central'
18+
required: true
19+
runs:
20+
using: composite
21+
steps:
22+
- name: Set Up JFrog CLI
23+
uses: jfrog/setup-jfrog-cli@9fe0f98bd45b19e6e931d457f4e98f8f84461fb5 # v4.4.1
24+
env:
25+
JF_ENV_SPRING: ${{ inputs.jfrog-cli-config-token }}
26+
- name: Download Release Artifacts
27+
shell: bash
28+
run: jf rt download --spec ${{ format('{0}/artifacts.spec', github.action_path) }} --spec-vars 'buildName=${{ format('spring-webflow-{0}', inputs.spring-webflow-version) }};buildNumber=${{ github.run_number }}'
29+
- name: Sync
30+
uses: spring-io/nexus-sync-action@42477a2230a2f694f9eaa4643fa9e76b99b7ab84 # v0.0.1
31+
with:
32+
close: true
33+
create: true
34+
generate-checksums: true
35+
password: ${{ inputs.ossrh-s01-token-password }}
36+
release: true
37+
staging-profile-name: ${{ inputs.ossrh-s01-staging-profile }}
38+
upload: true
39+
username: ${{ inputs.ossrh-s01-token-username }}
40+
- name: Await
41+
uses: ./.github/actions/await-http-resource
42+
with:
43+
url: ${{ format('https://repo.maven.apache.org/maven2/org/springframework/webflow/spring-webflow/{0}/spring-webflow-{0}.jar', inputs.spring-webflow-version) }}

‎.github/actions/sync-to-maven-central/artifacts.spec

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"files": [
3+
{
4+
"aql": {
5+
"items.find": {
6+
"$and": [
7+
{
8+
"@build.name": "${buildName}",
9+
"@build.number": "${buildNumber}",
10+
"path": {
11+
"$nmatch": "org/springframework/webflow/webflow/webflow-*.zip"
12+
}
13+
}
14+
]
15+
}
16+
},
17+
"target": "nexus/"
18+
}
19+
]
20+
}

‎.github/workflows/release.yml

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
name: Release
2+
on:
3+
push:
4+
tags:
5+
- v3.0.[0-9]+
6+
concurrency:
7+
group: ${{ github.workflow }}-${{ github.ref }}
8+
jobs:
9+
build-and-stage-release:
10+
name: Build and Stage Release
11+
if: ${{ github.repository == 'spring-projects/spring-webflow' }}
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Check Out Code
15+
uses: actions/checkout@v4
16+
- name: Build and Publish
17+
id: build-and-publish
18+
uses: ./.github/actions/build
19+
with:
20+
develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
21+
opensource-repository-password: ${{ secrets.ARTIFACTORY_PASSWORD }}
22+
opensource-repository-username: ${{ secrets.ARTIFACTORY_USERNAME }}
23+
publish: true
24+
- name: Stage Release
25+
uses: spring-io/artifactory-deploy-action@26bbe925a75f4f863e1e529e85be2d0093cac116 # v0.0.1
26+
with:
27+
artifact-properties: |
28+
/**/webflow-*.zip::zip.name=spring-webflow,zip.deployed=false
29+
/**/webflow-*-docs.zip::zip.type=docs
30+
/**/webflow-*-dist.zip::zip.type=dist
31+
/**/webflow-*-schema.zip::zip.type=schema
32+
build-name: ${{ format('spring-webflow-{0}', steps.build-and-publish.outputs.version)}}
33+
folder: 'deployment-repository'
34+
password: ${{ secrets.ARTIFACTORY_PASSWORD }}
35+
repository: 'libs-staging-local'
36+
signing-key: ${{ secrets.GPG_PRIVATE_KEY }}
37+
signing-passphrase: ${{ secrets.GPG_PASSPHRASE }}
38+
uri: 'https://repo.spring.io'
39+
username: ${{ secrets.ARTIFACTORY_USERNAME }}
40+
outputs:
41+
version: ${{ steps.build-and-publish.outputs.version }}
42+
sync-to-maven-central:
43+
name: Sync to Maven Central
44+
needs:
45+
- build-and-stage-release
46+
runs-on: ubuntu-latest
47+
steps:
48+
- name: Check Out Code
49+
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
50+
- name: Sync to Maven Central
51+
uses: ./.github/actions/sync-to-maven-central
52+
with:
53+
jfrog-cli-config-token: ${{ secrets.JF_ARTIFACTORY_SPRING }}
54+
ossrh-s01-staging-profile: ${{ secrets.OSSRH_S01_STAGING_PROFILE }}
55+
ossrh-s01-token-password: ${{ secrets.OSSRH_S01_TOKEN_PASSWORD }}
56+
ossrh-s01-token-username: ${{ secrets.OSSRH_S01_TOKEN_USERNAME }}
57+
spring-webflow-version: ${{ needs.build-and-stage-release.outputs.version }}
58+
promote-release:
59+
name: Promote Release
60+
needs:
61+
- build-and-stage-release
62+
- sync-to-maven-central
63+
runs-on: ubuntu-latest
64+
steps:
65+
- name: Set up JFrog CLI
66+
uses: jfrog/setup-jfrog-cli@9fe0f98bd45b19e6e931d457f4e98f8f84461fb5 # v4.4.1
67+
env:
68+
JF_ENV_SPRING: ${{ secrets.JF_ARTIFACTORY_SPRING }}
69+
- name: Promote build
70+
run: jfrog rt build-promote ${{ format('spring-webflow-{0}', needs.build-and-stage-release.outputs.version)}} ${{ github.run_number }} libs-release-local
71+
create-github-release:
72+
name: Create GitHub Release
73+
needs:
74+
- build-and-stage-release
75+
- promote-release
76+
runs-on: ubuntu-latest
77+
steps:
78+
- name: Check Out Code
79+
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
80+
- name: Create GitHub Release
81+
uses: ./.github/actions/create-github-release
82+
with:
83+
milestone: ${{ needs.build-and-stage-release.outputs.version }}
84+
token: ${{ secrets.GH_ACTIONS_REPO_TOKEN }}

0 commit comments

Comments
 (0)