thunderstore-publish

Github Action that uses the Thunderstore CLI to upload a package to Thunderstore

Usage

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 }}"

Categories

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.

Example

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...
  ]
}

Inputs

Outputs