mathieusoysal / jib-container-publish.yml

GitHub Actions for your Java project to build container with jib and publish it to GitHub Packages.

Build container with JIB and publish it to GitHub Packages

GitHub action to build container with jib and publish it to GitHub Packages.

Requirements

• Your project need to use Maven

Usage

The workflow, usually declared in .github/workflows/jib-publish.yml, looks like:

name: JIB container publish

on:
  release:
    types: [created]

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - name: JIB container build and publish
        uses: MathieuSoysal/[email protected]
        with:
          PASSWORD: ${{ secrets.GITHUB_TOKEN }}

You need to choice a registry other than GitHub Package ?

You can change the REGISTRY,USERNAME,PASSWORD to publish in the registry of your choice:

name: JIB container publish

on:
  release:
    types: [created]

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - name: JIB container build and publish
        uses: MathieuSoysal/[email protected]
        with:
          # Use docker.io for Docker Hub if empty
          REGISTRY: ghcr.io
          # github.repository as <your-account>/<your-repo>
          IMAGE_NAME: ${{ github.repository }}
          # Tag name of the image to publish
          tag-name: ${{ github.event.release.tag_name }}
          # Username to login to registry
          USERNAME: ${{ github.actor }}
          # Password to login to registry
          PASSWORD: ${{ secrets.GITHUB_TOKEN }}
          java-version: 17

Multi-Module Maven Projects

If you have a multi-module Maven project you can specify the main module containing the main class using the parameter module and the main class using the parameter main-class.

License

The Dockerfile and associated scripts and documentation in this project are released under the GPL-3.0 License.

jib-container-publish.yml's Issues

Action doesn't support java 21

Hidden updater seems not to work, as we have now jib 3.4.0 available

Add automated jib update

Problem

Currently, we are using the jib inside the action.yml file, but this dependency is not automatically updated.

Solution

We can use this GitHub Action : Hiden-dependancy-updater. For fix this issue.

Add automated tests

Current problem

Currently, we don't have any automated tests inside the project. This is a little problematic for the contribution, a contributor can't test if the added feature works correctly.

Solution to fix this

It's probably possible to use https://github.com/nektos/act inside a CI, to execute this JavaDoc publisher with a empty project.

Add compatibility for Gradle

Introduction

Currently the JIB-container-publish doesn't support java project with Gradle

Feature

Add some features to support a Gradle project too.