encounter/dtk-template
1
0
Fork 0
mirror of https://github.com/encounter/dtk-template.git synced 2025-12-18 09:25:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updates for decomp.dev (replaces frogress)

Browse Source 
Resolves #52
This commit is contained in:
Luke Street
2025-05-06 21:40:20 -06:00
parent bb558596e3
commit 2e907657cc
7 changed files with 26 additions and 188 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/github_actions.md
View File

@@ -3,8 +3,8 @@
This repository includes [.github.example/workflows/build.yml](/.github.example/workflows/build.yml) as an example CI workflow. To use it for your project, follow the setup instructions below.
- [Build Repository](#build-repository)
- [Progress](#progress)
- [Workflow](#workflow)
- [decomp.dev](#decompdev)
## Build Repository
@@ -25,18 +25,6 @@ This repository will be used to build and store the CI build container.
4. Under "Manage Actions access", add your project's main repository with the "Read" role:
![GitHub package Actions access](images/github_package_settings_access.png)
## Progress
1. In the [GC/Wii Decompilation Discord](https://discord.gg/hKx3FJJgrV), visit `#frogress` and request an API key for your project.
Please provide the following:
- Project name
- Repository URL
- Game ID(s)
- Whether the game has RELs
2. On GitHub, visit your repo's `/settings/secrets/actions/new` and add a new secret with the name `PROGRESS_API_KEY`:
![GitHub Actions secrets](images/github_actions_secrets.png)
## Workflow
1. Rename `.github.example` to `.github`.
@@ -45,8 +33,14 @@ This repository will be used to build and store the CI build container.
3. In `build.yml`, replace `GAMEID` with your game's ID. (Or list of IDs, for multi-version support.)
4. In `build.yml`, update `PROGRESS_SLUG` to match the project name on [frogress](#progress).
4. Commit and push the changes to your repository.
5. Commit and push the changes to your repository.
If everything is set up correctly, the workflow will build all versions on every push or pull request.
If everything is set up correctly, the workflow will build all versions on every push or pull request, and upload progress on pushes the `main` branch.
## decomp.dev
Once the build workflow is running on the main branch, you can add your game to <https://decomp.dev>.
Visit <https://decomp.dev/manage/new>, select your GitHub repository and fill out the required fields.
If you have questions or issues, try asking in the [GC/Wii Decompilation Discord](https://discord.gg/hKx3FJJgrV) #decomp.dev channel.