rothiotome / godot-very-simple-twitch

Very Simple Twitch Chat integration for Godot
MIT License
36 stars 3 forks source link

Create release-action #6

Closed Laurick closed 4 months ago

Laurick commented 4 months ago

⚠️ This functionality needs extra work from repo admin. See notes below⚠️

Why

The plugin for godot is not deployable and you must download all the project only for the plugin with all the data. With this, someone can download the addon without checkout all the repo and files you don't need. This action does not interfere with uploading the plugin at the addon shop at godot and its a cool way to add versioning to the project

How

Jusst added a github action in a tag push with 3 steps

  1. Checkout the last version of main
  2. Zip "addon" folder
  3. Add the zip to releases

Keep in mind this will not work unless a ACTION_TOKEN is set ( action will fail like 3 times ). See the notes below

Usage

The action is configured to raise on tags with the following pattern: "v{number}.{number}.{any}. The idea is when a release candidate is ready to deploy push a tag and github action create the release zip for anyone.

This release also could be tracked for badges and will appear at the rigth section of the main repo page.

Notes

For let github action use the repo you need add a token named "ACCESS_TOKEN" in the repo with "repo and workflow" privileges. This token must be private so keep away from people.

Create a token flow: "profile settings" -> "developer settings" -> "personal access token" Add a secret token flow: "repo settings" -> "secrets and variables" -> "actions" -> Repository secrets

See more information-> https://docs.github.com/en/enterprise-server@3.9/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens

Tests

Checked and tested on a private repository.

Tasks related

4