Skip to content
📦 GitHub Action for automatically publishing Maven packages
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
.editorconfig
.gitattributes
.gitignore
README.md
action.yml
index.js
package.json
settings.xml
yarn.lock

README.md

Maven Publish GitHub Action

GitHub Action for automatically publishing Maven packages

Overview

This action…

  • Executes the Maven deploy lifecycle phase
  • Provides Maven with your GPG key and passphrase so your artifacts can be signed using maven-gpg-plugin
  • Provides Maven with your Nexus credentials so it can deploy and release your project

It will also use the deploy Maven profile if you've defined one (in case you want to perform certain steps only when deploying).

Setup

Deployment

It's recommended to publish using the Nexus Staging Maven Plugin, which greatly simplifies the process. You can follow this guide for a simple configuration.

Make sure your project is correctly configured for deployment before continuing with the next step.

Workflow

Secrets

In your project's GitHub repository, go to Settings → Secrets. On this page, set the following variables:

  • gpg_private_key: GPG private key for signing the published artifacts:
    • Run gpg --list-secret-keys and copy the ID of the key you'd like to use
    • Export the key with gpg -a --export-secret-keys KEY_ID (and replace KEY_ID with the ID you copied)
  • gpg_passphrase: Passphrase for the GPG key
  • nexus_username: Username (not email!) for your Nexus repository manager account
  • nexus_password: Password for your Nexus account

Workflow file

Create a GitHub workflow file (e.g. .github/workflows/release.yml) in your repository. Use the following configuration, which tells GitHub to use the Maven Publish Action when running your CI pipeline. The steps are self-explanatory:

name: Release

# Run workflow on commits to the `master` branch
on:
  push:
    branches:
      - master

jobs:
  release:
    runs-on: ubuntu-18.04
    steps:
      - name: Check out Git repository
        uses: actions/checkout@v1

      - name: Install Java and Maven
        uses: actions/setup-java@v1
        with:
          java-version: 11

      - name: Release Maven package
        uses: samuelmeuli/action-maven-publish@v1
        with:
          gpg_private_key: ${{ secrets.gpg_private_key }}
          gpg_passphrase: ${{ secrets.gpg_passphrase }}
          nexus_username: ${{ secrets.nexus_username }}
          nexus_password: ${{ secrets.nexus_password }}

Every time you push to master, the action will be executed. If your pom.xml file contains a non-snapshot version number and all tests pass, your package will be deployed automatically.

Configuration

In addition to the input variables listed above, the action can be configured with the following options:

  • server_id: The default Nexus instance used by this action is OSSRH. If you are deploying to a different Nexus instance, you can specify the server ID you've used in your project's POM file (in the nexus-staging-maven-plugin and distributionManagement configurations) here
  • maven_args: Additional flags/arguments to pass to the Maven deploy command

Development

Contributing

Suggestions and contributions are always welcome! Please discuss larger changes via issue before submitting a pull request.

Setup

Make sure you have Node.js and Yarn installed.

After cloning this repository, do the following:

  1. Install all dependencies using yarn install. This will set up Git hooks so your code is linted and formatted before creating a commit
  2. Make your modifications to the action
  3. Test your action on a repository. You can import it from your fork like this: uses: your-github-username/action-maven-publish@your-branch-name
You can’t perform that action at this time.