Publish a package from Github - SynoCommunity/spksrc GitHub Wiki

Setup

  1. Get your API KEY
  2. Set up GitHub Secrets in GitHub Action workflow
    1. On GitHub, navigate to the main page of your fork of this repository.
    2. Under your repository name, click on the "Settings" tab.
    3. In the left sidebar, click "Secrets".
    4. On the right bar, click on "New repository secret"
    5. Type a name for your secret PUBLISH_API_KEY in the "Name" input box.
    6. Paste your API KEY as the value for your secret.
    7. Click Add secret. GitHub Secrets

Run Build/Publish workflow

Make sure you test your package toughly before proceeding.

https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow

Web GUI

  1. Open GitHub.com and navigate to the build action: https://github.com/{YOUR_GITHUB_USERNAME}/spksrc/actions/workflows/build.yml
  2. Click the Run Workflow button. Enter the package name you want to publish
  3. Type "true" in the Publish to repository field and click Run Workflow
  4. If everything went well, you should see the package build and published to synocommunity.com
  5. Do final tests and finally Activate your package
  6. Celebrate! 🥳

If you get a "Startup failure" make sure to enable Settings -> Actions -> Actions permissions -> Allow all actions

CLI (github cli)

  1. gh workflow -R {YOUR_GITHUB_USERNAME}/spksrc run build.yml -f package=nop -f publish=false
    1. See the build status gh run -R {YOUR_GITHUB_USERNAME}/spksrc watch && notify-send -i "github" -a "GitHub" "🛠 Build is done! 🎉" "To view the build visit https://synocommunity.com/admin/build"
  2. If everything went well, you should see the package build and published to synocommunity.com
  3. Do final tests and finally Activate your package
  4. Celebrate! 🥳

Optional - make a GitHub release:

  1. Create a tag with the following format: packagename-version
    • git tag -a -s -m lidarr-0.8.0.2042 lidarr-0.8.0.2042
  2. Push the tag to your fork:
    • git push --tags origin lidarr-0.8.0.2042
  3. If everything went well, you should see the package artifacts attached to your GitHub release.

Troubleshooting

Startup failure Error

Fix: goto Settings -> Actions and choose "allow all actions" from the options.