https://github.com/ate47/mc_ci
Repository to sync the workflows of all my mods 🚀
https://github.com/ate47/mc_ci
continuous-integration github-actions sync
Last synced: about 1 month ago
JSON representation
Repository to sync the workflows of all my mods 🚀
- Host: GitHub
- URL: https://github.com/ate47/mc_ci
- Owner: ate47
- License: epl-2.0
- Created: 2022-07-15T08:47:57.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-25T13:58:04.000Z (about 3 years ago)
- Last Synced: 2025-10-26T20:49:14.708Z (8 months ago)
- Topics: continuous-integration, github-actions, sync
- Language: PowerShell
- Homepage:
- Size: 66.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
**Minecraft CI 🚀**
Project to test/sync ci to all my mods
[Test project on CurseForge](https://www.curseforge.com/minecraft/mc-mods/ci-test-mod)
- [Minecraft CI](#minecraft-ci)
- [`project.json` schema](#projectjson-schema)
- [Scripts](#scripts)
- [Sync process](#sync-process)
- [Using workflow](#using-workflow)
- [Using command line](#using-command-line)
# Minecraft CI
I'm a Powershell user, so my scripts are with [Powershell](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7).
## `project.json` schema
Config file to store the projects.
```json
{
"projects": [
{
"id": "user/repository",
"branches": ["branch1", "branch2"]
}
]
}
```
## Scripts
- `list_project.ps1`: Print a list of the projects.
- `update_project.ps1 -Id "user/repo" (-Editor "text-editor-cmd")`: Create or update a project, will open a file with an editor to select which branch to sync.
- `delete_project.ps1 -Id "user/repo"`: Delete a project.
- `get_project.ps1 -Id "user/repo"`: Get a project.
- `update_sync_commit.ps1 (-Editor "text-editor-cmd") (-Message "commit message")`: Set the sync commit message.
- `init.ps1`: Init the project.json file, done by default with the other scripts.
- `sync.ps1`: Sync the projects. [See Sync process](#sync-process-)
## Sync process
all files in the `common.github` directory will be sync into the branches/projects with one commit with the message described in `sync_commit_message.txt`.
### Using workflow
By default it should be used using the `.github/workflows/sync.yml` workflow.
for forks, 2 secrets are required to config the account to push the sync commits, this account should have at least the repository and workflows permissions on the project's repositories.
- `GH_PAT`: Github token/password.
- `GH_USERNAME`: Github username.
You can run the command to sync by using this command:
### Using command line
```powershell
scripts/sync.ps1 `
-IKnowWhatImDoing `
-File "config/project.json"`
-GitUser 'username for the sync commit'`
-GitMail 'mail for the sync commit'`
-GitPushUser 'Github username'`
-GitPassword 'Github password or token'
```
The names are pretty much self explaining, but:
- `-IKnowWhatImDoing`: Mandadory, admit it'll be your fault.
- `-File`: project.json file, by default `"config/project.json"`.
- `-GitUser`: username for the sync commit.
- `-GitMail`: mail for the sync commit.
- `-GitPushUser`: Github username to push the sync commit.
- `-GitPassword`: Github password or token to push the sync commit.