Github Action that uses the Thunderstore CLI to upload a package to Thunderstore
name: Publish
on:
release:
types: [ released ]
jobs:
publish:
runs-on: ubuntu-latest
steps:
- name: Fetch Sources
uses: actions/checkout@v4
with:
ref: ${{ github.event.release.tag_name }}
fetch-depth: 0
filter: tree:0
- uses: dhkatz/thunderstore-publish@v1
id: publish
with:
token: ${{ secrets.TS_TOKEN }}
namespace: yournamespace # the namespace to publish under (ie. your username or team name)
name: Your Cool Package
description: Your cool package description
version: ${{ github.event.release.tag_name }}
communities: YourCommunity
categories: |
foo
bar-baz
- name: Output URL
run: echo "Published Thunderstore package to ${{ steps.publish.outputs.url }}"
Figuring out how to refer to your community's categories can be somewhat confusing.
To find the categories available to your community, check out https://thunderstore.io/api/experimental/community/YOUR_COMMUNITY/category/, which will return a list of categories in a JSON format. Each category will have a name value and a slug value. The slug is the value you need to put in the categories list of the action.
On Linux with jq installed:
curl -X GET "https://thunderstore.io/api/experimental/community/northstar/category/" -H "accept: application/json" | jq # 'jq' is a command line utility that formats JSON
{
"pagination": {
"next_link": null,
"previous_link": null
},
"results": [
{
"name": "Models",
"slug": "models"
},
{
"name": "Maps",
"slug": "maps"
},
// a bunch of others...
]
}
| Input | Description | Required |
|---|---|---|
token |
Service account token from Thunderstore. Should be saved as a repo secret and accessed with ${{ secrets.YOUR_TOKEN_NAME }} |
true |
communities |
Thunderstore community to publish to. | true |
namespace |
Name of the team to publish under. | true |
name |
Name of the package. | true |
description |
Description of the package that will appear on Thunderstore. | true |
version |
Package version in SemVer format. | true |
repo |
URL or hostname of the repository to publish to (see #22). | false |
file |
Path to a prebuilt zip file. Will skip the build step if provided. | false |
path |
Path of the files to package. Useful when using build artifacts from other steps. Defaults to using the contents of the repo. | false |
icon |
URL to download the icon from. Will try to find icon.png in the root of the repo if not provided. |
false |
readme |
URL to download the readme from. Will try to find README.md in the root of the repo if not provided. |
false |
dev |
Publish to https://thunderstore.dev if set, https://thunderstore.io if not set. | false |
categories |
A list, separated by newline characters, of categories to give to the mod when published. These must be available in the community you're publishing to. | false |
deps |
A list, separated by spaces, of mods this mod depends on. Must be in [email protected] format. The publish will fail if any of these aren't a real package. |
false |
website |
The homepage URL for the mod. Defaults to the github repo URL. | false |
nsfw |
Set this to true mark the mod as NSFW |
false |
| Output | Description |
|---|---|
url |
The download URL of the published package |