Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backend: Update Github action [Do not merge until dependencies are done] #3161

Draft
wants to merge 4 commits into
base: beta
Choose a base branch
from

Conversation

CalMWolfs
Copy link
Collaborator

@CalMWolfs CalMWolfs commented Jan 5, 2025

Draft until we work out how releases will work as they changelog format for those may need to change

Dependencies

These need to be done before its merged [Requires hannibal/jani]

  • Github secret MODRINTH_TOKEN which is the modrinth token for the skyhanni project on modrinth
  • Github secret DISCORD_WEBHOOK_PRE_UPDATE which is the webhook url for the discord channel #hanni-predicting-the-next-sh-update

What

Adds github actions that helps with making releases of the mod.

This reduces some of the time it takes for hannibal to do releases.
It will also be important once we have multiversion as it will speed that process up a lot

How to use and what it does

  • When you are ready to make a release run /gradlew prepareRelease -Pver=X.X.X where ver is equal to the version you want to release.
  • This will automatically create the tag for the update and create a draft release for this tag on github.
  • The discord internal changelog will then be sent to #hanni-predicting-the-next-sh-update
  • Once you are satisfied with the update, go into the draft release and change it to no longer be a draft.
  • It will then publish it to modrinth and finalise the changelog if any pr descriptions were edited since the draft was created
  • The version change will then be committed to the beta branch so this does not need to be done manually anymore

Notes:

  • You still have to post the release changelog in either the beta or releases channel at this time, but this can be changed to be done automatically if wanted in the future
  • You have to commit the changelog and feature changes to the mod still but no longer have to commit the version change as it will do that itself.
  • You can now use the changelog generator in the SkyHanni repo with ./gradlew generateChangelog. This allows anyone to see what the changelog will look like at any time

Changelog Technical Details

  • Added github actions that allow for easily creating releases of the mod. - CalMWolfs
  • The changelog generator can now be used from within SkyHanni repo ./gradlew generateChangelog. - CalMWolfs

@github-actions github-actions bot added the Backend A backend pull request that will be merged soon label Jan 5, 2025
@jani270
Copy link
Collaborator

jani270 commented Jan 5, 2025

PogU

@CalMWolfs CalMWolfs marked this pull request as draft January 5, 2025 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backend A backend pull request that will be merged soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants