-
Notifications
You must be signed in to change notification settings - Fork 0
S217 : build and publish pkg via mvn to gh packages #92
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
Open
eschultink
wants to merge
3
commits into
main
Choose a base branch
from
s217-build-and-publish-pkg
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| name: Publish Maven Artifacts | ||
|
|
||
| # This workflow publishes Maven artifacts to GitHub Packages. | ||
| # | ||
| # Security: | ||
| # - Uses GITHUB_TOKEN (automatically provided by GitHub Actions) | ||
| # - workflow_dispatch requires write access (enforced by GitHub) | ||
| # - Tag pushes require push access (enforced by GitHub) | ||
| # - RC branch pushes require write access (enforced by GitHub) | ||
| # - Consider adding branch protection rules to restrict who can push tags and create rc-* branches | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| push: | ||
| tags: | ||
| - 'v*' | ||
| branches: | ||
| - 'rc-*' | ||
|
|
||
| jobs: | ||
| publish: | ||
| name: Publish Maven Artifacts to GitHub Packages | ||
| runs-on: ubuntu-latest | ||
| # Security: Only run on authorized triggers | ||
| # - Tags (v*): Regular releases, anyone with push access can create tags | ||
| # - RC branches (rc-*): Release candidates, requires write access (includes PR merges) | ||
| # - workflow_dispatch: Manual trigger, requires write access (checked in step below) | ||
| permissions: | ||
| contents: read | ||
| packages: write | ||
|
|
||
| steps: | ||
| - name: Verify authorization for manual trigger | ||
| if: github.event_name == 'workflow_dispatch' | ||
| run: | | ||
| # For manual triggers, verify the user has write access to the repository | ||
| # This prevents unauthorized users from triggering the workflow | ||
| # Note: GitHub will also enforce permissions | ||
|
|
||
| # Check if actor is a member of the organization or has write access | ||
| # This is a basic check - GitHub will also enforce permissions | ||
| if [ "${{ github.event.sender.type }}" != "User" ] && [ "${{ github.event.sender.type }}" != "Bot" ]; then | ||
| echo "❌ ERROR: Unauthorized trigger. Only users and bots can trigger this workflow." | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "✓ Authorized trigger by: ${{ github.event.sender.login }}" | ||
| echo " Actor type: ${{ github.event.sender.type }}" | ||
| echo " Repository: ${{ github.repository }}" | ||
| echo "" | ||
| echo "Note: This workflow requires write access to the repository." | ||
| echo "GitHub will enforce this permission check before allowing the workflow to run." | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Set up JDK | ||
| uses: actions/setup-java@v4 | ||
| with: | ||
| java-version: '21' | ||
| distribution: 'temurin' | ||
| cache: 'maven' | ||
| server-id: github | ||
| server-username: GITHUB_ACTOR | ||
| server-password: GITHUB_TOKEN | ||
|
|
||
| - name: Publish Maven Artifacts | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| GITHUB_ACTOR: ${{ github.actor }} | ||
| run: | | ||
| cd java | ||
|
|
||
| # Determine if RC build; assume it is UNLESS ref is tag starting with v (e.g., v0.5.15) | ||
| RC_OPTION="--rc" | ||
| REF_NAME="${{ github.ref_name }}" | ||
| if [[ "$REF_NAME" =~ ^v[0-9]+\.[0-9]+\.[0-9]+ ]]; then | ||
| RC_OPTION="" | ||
| fi | ||
|
|
||
| # Read base version from pom.xml | ||
| BASE_VERSION=$(sed -n 's|[[:space:]]*<revision>\(.*\)</revision>|\1|p' pom.xml) | ||
| if [ -z "$BASE_VERSION" ]; then | ||
| echo "❌ ERROR: Could not extract from pom.xml '<revision>' property. Ensure pom.xml uses <version>\${revision}</version> and has a <revision> property." | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Determine version based on RC_OPTION | ||
| if [ -z "$RC_OPTION" ]; then | ||
| # Non-RC build: extract version from tag | ||
| VERSION="${REF_NAME#v}" | ||
| echo "✓ Detected version tag: $REF_NAME, extracted version: $VERSION" | ||
| echo "✓ This is a release build (non-RC)" | ||
| else | ||
| # RC build: use version from pom.xml and add -SNAPSHOT suffix | ||
| VERSION="$BASE_VERSION-SNAPSHOT" | ||
| echo "✓ Using version from pom.xml: $BASE_VERSION" | ||
| echo "✓ This is an RC build, final version: $VERSION" | ||
| fi | ||
|
|
||
| # Build and deploy Maven artifacts with the determined version | ||
| # Pass -Drevision to override the version in pom.xml | ||
| echo "Building and deploying with version: $VERSION" | ||
| if mvn clean deploy -DskipTests -Drevision="$VERSION"; then | ||
| echo "✓ Maven artifacts published to GitHub Packages" | ||
| echo "Published version: $VERSION" | ||
| else | ||
| echo "❌ Maven deploy failed" | ||
| exit 1 | ||
| fi | ||
| - name: Summary | ||
| if: success() | ||
| run: | | ||
| cd java | ||
|
|
||
| # Determine the published version (same logic as publish step) | ||
| # Determine if RC build; assume it is UNLESS ref is tag starting with v (e.g., v0.5.15) | ||
| RC_OPTION="--rc" | ||
| REF_NAME="${{ github.ref_name }}" | ||
| if [[ "$REF_NAME" =~ ^v[0-9]+\.[0-9]+\.[0-9]+ ]]; then | ||
| RC_OPTION="" | ||
| fi | ||
|
|
||
| BASE_VERSION=$(sed -n 's|[[:space:]]*<revision>\(.*\)</revision>|\1|p' pom.xml) | ||
|
|
||
| if [ -z "$RC_OPTION" ]; then | ||
| PUBLISHED_VERSION="${REF_NAME#v}" | ||
| BUILD_TYPE="Release" | ||
| else | ||
| PUBLISHED_VERSION="${BASE_VERSION}-SNAPSHOT" | ||
| BUILD_TYPE="Snapshot (RC)" | ||
| fi | ||
|
|
||
| echo "## ✅ Successfully published Maven artifacts" >> $GITHUB_STEP_SUMMARY | ||
| echo "" >> $GITHUB_STEP_SUMMARY | ||
| echo "**Version:** \`${PUBLISHED_VERSION}\`" >> $GITHUB_STEP_SUMMARY | ||
| echo "**Build Type:** ${BUILD_TYPE}" >> $GITHUB_STEP_SUMMARY | ||
| echo "" >> $GITHUB_STEP_SUMMARY | ||
| echo "Artifacts have been published to GitHub Packages." >> $GITHUB_STEP_SUMMARY | ||
| echo "" >> $GITHUB_STEP_SUMMARY | ||
| echo "Repository: https://github.com/Worklytics/appengine-pipelines/packages" >> $GITHUB_STEP_SUMMARY | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The version determination logic is duplicated between the 'Publish Maven Artifacts' step (lines 73-98) and the 'Summary' step (lines 116-131). Extract this logic into a reusable function or consolidate it into a single step that sets environment variables for subsequent steps to use.