Skip to content
MCEnginePublic

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

7 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 

Repository files navigation

actions

Shared GitHub Actions workflows for the MCEngine family of Minecraft plugins. Each plugin repository keeps its own thin publish.yml and release.yml, and those call the reusable workflows here, so the release logic lives in one place.

Workflow What it does
publish.yml When a release/{version} pull request merges, tests, publishes the library modules to GitHub Packages, and tags v{project-version} when that tag does not exist yet.
release.yml Builds the distributed jars from the tag and attaches them to a GitHub release, with the version's changelog as the notes.

Using them from a plugin

.github/workflows/publish.yml:

name: Publish

on:
  pull_request:
    types: [closed]
    branches: [master]
  workflow_dispatch:

concurrency:
  group: release
  cancel-in-progress: false

permissions: {}

jobs:
  publish:
    # Only a merged release/{version} pull request, or a retry by hand.
    if: >-
      github.event_name == 'workflow_dispatch' ||
      (github.event.pull_request.merged &&
       startsWith(github.event.pull_request.head.ref, 'release/'))
    permissions:
      contents: write
      packages: write
    uses: MCEngine/actions/.github/workflows/publish.yml@master
    secrets: inherit

.github/workflows/release.yml:

name: Release

on:
  workflow_run:
    workflows: [Publish]
    types: [completed]
    branches: ['release/**', master]
  workflow_dispatch:
    inputs:
      tag:
        description: Tag to release, such as v1.2.0. Leave it empty for the version in gradle.properties.
        required: false
        type: string

concurrency:
  group: github-release
  cancel-in-progress: false

permissions: {}

jobs:
  release:
    if: github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success'
    permissions:
      contents: write
      actions: write
      packages: read
    uses: MCEngine/actions/.github/workflows/release.yml@master
    with:
      tag: ${{ inputs.tag }}

Inputs

publish.yml

Input Default Meaning
java-version 25 JDK used for the build.
publish-packages true Run publish-task. Set false for a plugin that publishes no library; the run still tests and tags.
build-task build Gradle task that builds and tests.
publish-task publish Gradle task that publishes to GitHub Packages.

release.yml

Input Default Meaning
tag empty Tag to release; empty means v{project-version}.
jars platforms/engine/build/libs/*-{version}.jar Newline-separated globs; {version} is replaced, and each glob must match one jar.
java-version 25 JDK used for the build.
assemble-task assemble Gradle task that builds the jars.

Conventions the workflows rely on

  • The version is project-version in gradle.properties, as Major.Minor.Patch. 0.0.0 means nothing has been released and is never tagged.
  • The default branch is master.
  • A release ships by merging a pull request from release/{version}, where {version} is the project-version it merges, with no v. Publish skips every other pull request and every push, so an ordinary merge publishes nothing; a release/ branch whose name and project-version disagree fails. workflow_dispatch from master retries a release after a failure.
  • Release notes come from wiki/logs/{Major}/{Minor}/{Patch}/CHANGELOG.md when it exists in the tagged commit; otherwise GitHub lists the merged pull requests.
  • The Gradle build reads GITHUB_ACTOR and GITHUB_TOKEN for its GitHub Packages repositories, both to publish and to resolve another plugin's library; the workflows set them on every Gradle step.
  • A plugin that resolves another repository's package needs that package to grant it access (the package's Manage Actions access setting), because the workflow token only reaches its own repository's packages by default.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors