Skip to content

Making a public index

harmless-tech edited this page Aug 21, 2023 · 7 revisions
  1. Click on Use as template here, then Create a new repository.
  2. Give it a name, set it as public, and make sure to check Include all branches.
  3. Add releases for stable-index, track-index, and banned-index.
    • Click on Create a new release under Releases.
    • For Choose a tag use one of the above, create them if needed. Give it a title if you want, then publish the release.
    • Repeat for all tags.
  4. Generate a token: (This is needed because the Check for updates workflow creates and pushes other workflows)
    • Go to https://github.com/settings/tokens?type=beta and click Generate new token.
    • Give it a name and a long expiry.
    • For Repository access click Only select repositories and add your created index.
    • For Repository permissions give it Actions and Contents, both with read and write permissions.
    • Generate the token and keep it handy.
  5. Click on the Settings tab then go to Secrets and variables -> Actions.
  6. Create a New repository secret called WORKFLOW_TOKEN, paste in your token from step 5 and click add.
  7. Add a minisign private key called MINISIGN_SIGNING_KEY, or remove the step named Sign info.json and hashes.json in stable.template.yml.
    • Make sure to put your minisign public key somewhere so people can verify archives from your index.
  8. Click on the Actions tab and make sure they can run.

Now you are ready to add crates to your index.

Clone this wiki locally