Automatically update the description for a Modrinth project.

Required

The auth token to use for the Modrinth API

To get this, you need to:

1. Sign into Modrinth
2. Access your cookies (Shift + F9 in FireFox, maybe something similar on Chrome)
3. Copy the auth-token cookie
4. Put it in a GitHub Secret
5. You're done!

Required

The slug or id used to identify the project on Modrinth.

This is the part that you can type in the "URL" box in the settings.

You can also use the id which can be found under the project information panel.

Optional, default = README.md

The path to the readme to fetch from the root of the GitHub repo.

on:
  push:
    branches: [ main ]
jobs:
  modrinth-desc:
    runs-on: 'ubuntu-latest'
    steps:
    - uses: actions/checkout@v3
    - uses: actions/modrinth-auto-desc@v1
      with:
        auth-token: ${{ secrets.MODRINTH_AUTH_TOKEN }}
        slug: 'mapify'