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

Automatic changelogs #208

Merged
merged 6 commits into from
Aug 14, 2023

Conversation

DebugOk
Copy link
Contributor

@DebugOk DebugOk commented Aug 14, 2023

About the PR

About time!

Still had to use the .js version from Delta because the .py from stationware didn't seem to work on my test repo

Setup required!!

The following secrets are required
BOT_TOKEN = A GitHub PAT with at least contents Read & Write for the repository, and the ability to bypass branch protections
CHANGELOG_DISCORD_WEBHOOK = A Discord webhook to send changelogs to

The following variables are required
CHANGELOG_USER = The username for the changelog commits
CHANGELOG_EMAIL = The email for the changelog commits (all metadata)
CHANGELOG_MESSAGE = The commit message shown. If set to something like "Automatic Changelog Update", commits will show up as "Automatic Changelog Update (#1234)"

Settings these all up before merging will mean its also tested upon merge. Changelogs will be published every day, but can also be manually triggered via a workflow dispatch.

Changelog

🆑

  • add: This is a test changelog to confirm that automatic changelogs are working

@DebugOk
Copy link
Contributor Author

DebugOk commented Aug 14, 2023

Also important, make sure the server.id cvar is set to something unique, otherwise new changelogs dont show as "new" in game

@FrontierATC
Copy link
Collaborator

pretty sure i did but i can always double check

@DebugOk
Copy link
Contributor Author

DebugOk commented Aug 14, 2023

pretty sure i did but i can always double check

Its not super important, as all it does it make the changelog button light up if theres new ones. Its still nice to have and takes little effort to change

@DebugOk
Copy link
Contributor Author

DebugOk commented Aug 14, 2023

Also, it might be better to change it to something new if you did have it set, as a majority of clients will still have the old changelog amount stored

@Cheackraze Cheackraze merged commit ac69c91 into new-frontiers-14:master Aug 14, 2023
11 checks passed
FrontierATC added a commit that referenced this pull request Aug 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants