Added GitHub Action that automatically pulls from Crowdin and updates strings. Also adds a translation progress badge to README because why not?
Why did you do this?
Makes it easier to integrate with Crowdin. The current solution being used at StopMalwareContent (owned by Nitrrine) is apparently not the best? And using the CLI via pnpm may expose secrets.
BREAKING CHANGES
[ ] Tick this box if you made changes that may or may not break site functionality.
What issues (if any) would this resolve?
Resolves #36
Extra notes?
This PR should not be merged until all secrets are set. The secrets that need to be set are the following:
CROWDIN_PROJECT_ID (this can be obtained by having @blryface go to this webpage and finding it there)
CROWDIN_PERSONAL_TOKEN (can be created at Crowdin's API key page. Once again requires @blryface to do it probably)
A token that "has the repo scope selected" (Crowdin GitHub Action Page said this). I think a contents: write GITHUB_TOKEN should work, but if for some reason it doesn't (I can't test rn due to some factors namely requiring Crowdin strings to be not updated I think?) then a collaborator/owner of the repo needs to create a GitHub PAT with the scope selected.
Checklist
[ ] I have put clear & concise details about the mod onto the page.
[ ] Links I have put in are all valid.
[ ] Mods added are not RATs.
[ ] I have clearly stated why I want this to be changed.
[ ] For major changes, I have clearly stated what they are and why I've done them.
[ ] Any new resources put in are safe and not malicious.
[x] I have clearly explained why I have done this.
[x] I have proofread the documentation changed and have ensured there are no spelling or grammatical errors.
[ ] (Workflow updates only) I have tested the workflow to ensure its functionality.
[x] I have searched for duplicate PRs and have not found any.
[ ] I did not read this section.
Vercel will begin deploying to the Preview environment shortly after submitting this pull request. You may click on the "Visit Preview" link below to see a preview of what your changes look like.
If you updated only part of the repository such that it would not modify the website at all, you do not need to see the Vercel deployment.
You may also use the StackBlitz Codeflow button to quickview the PR in the browser and make changes at the same time if necessary.
Pull request template
Category
Describe changes
Added GitHub Action that automatically pulls from Crowdin and updates strings. Also adds a translation progress badge to README because why not?
Why did you do this?
Makes it easier to integrate with Crowdin. The current solution being used at StopMalwareContent (owned by Nitrrine) is apparently not the best? And using the CLI via
pnpm
may expose secrets.BREAKING CHANGES
What issues (if any) would this resolve?
Resolves #36
Extra notes?
This PR should not be merged until all secrets are set. The secrets that need to be set are the following:
contents: write
GITHUB_TOKEN should work, but if for some reason it doesn't (I can't test rn due to some factors namely requiring Crowdin strings to be not updated I think?) then a collaborator/owner of the repo needs to create a GitHub PAT with the scope selected.Checklist
Vercel will begin deploying to the Preview environment shortly after submitting this pull request. You may click on the "Visit Preview" link below to see a preview of what your changes look like. If you updated only part of the repository such that it would not modify the website at all, you do not need to see the Vercel deployment.
You may also use the StackBlitz Codeflow button to quickview the PR in the browser and make changes at the same time if necessary.