Releasing from CI

A release puts files from your build into your templates. Tag it v1.4.2 and every template it names gets a new version. Tag it with a dash, like v1.5.0-beta.1, and each template gets a draft that someone publishes from the panel. A file that hasn't changed since the last version adds nothing.

Make a token

In the panel, open Settings, People, Tokens and create a CI token. Pick the templates it may publish to. The panel shows the token once, so save it straight away as the CI secret ATLAS_TOKEN.

A personal token, under Profile, Tokens, has only a name. It acts as you, with the role you have when it's used, and it's the one atlasDev needs.

Send the release

.github/workflows/release.yml
on:
  push:
    tags: ["v*"]

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - run: ./gradlew build
      - uses: getatlasgg/publish@v1
        with:
          panel: https://panel.example.net
          token: ${{ secrets.ATLAS_TOKEN }}
          files: |
            games/dusty-dunes:plugins/DustyDunes.jar = build/libs/DustyDunes.jar

Add the panel's address and the token, and list each file on its own line. The Action reads the tag and the commit link from the push.

Try a build on a dev server

While you work on a plugin, ./gradlew atlasDev sends the build into a draft instead of a release. Turn on server to also run it:

build.gradle.kts
atlas {
    publish("games/survival-games", "plugins/SG.jar", tasks.shadowJar)
    dev { server = true }
}

atlasDev signs in with a personal token. Make one under Profile, Tokens and set it as ATLAS_TOKEN. A CI token from Settings can't push into a draft.

The build goes into the draft you last opened, created or changed in the panel, one per template. Open another draft and the next build lands there. When you have no draft on a template yet, the first build makes one named after the template and you, like survival-games-esmay. To pick a draft by name for one build, add -Patlas.draft=<name>.

With server on, Atlas starts the draft's dev server, or restarts it when it already runs. It uses the group of the draft's dev server, or the group you last opened in the panel. If your Minecraft account is linked, the proxy sends you onto the server once it runs.

A build only replaces the files it names, so config you changed in the draft stays. When someone published since your draft started, Atlas first brings the draft up to date. If your files clash with the live version, the build still lands and Gradle names the draft, so you pick a side in the panel. atlasPublish and the Action keep releasing as described above.

Which file goes where

Each file is one line in the form template:path = file.

Part What it is
template The template's name, like games/dusty-dunes
path Where the file lands in the template, like plugins/DustyDunes.jar
file The file your build made

A release with several files publishes all of them or none.

Keep versions close

The snippets on this page always show the newest release. A panel takes releases from its own minor version of the CLI or the Gradle plugin, or the one before, so update them when you update the panel.