https://github.com/friends-of-monika/submod-check
🔧 A reusable workflow that you can use to pre-emptively perform submod syntax and init block tests on every push.
https://github.com/friends-of-monika/submod-check
actions ddlc github-actions mas modding monika monika-after-story reusable-workflow submodding
Last synced: 3 months ago
JSON representation
🔧 A reusable workflow that you can use to pre-emptively perform submod syntax and init block tests on every push.
- Host: GitHub
- URL: https://github.com/friends-of-monika/submod-check
- Owner: Friends-of-Monika
- License: bsd-3-clause
- Created: 2022-12-04T15:01:44.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-12-23T21:49:35.000Z (over 2 years ago)
- Last Synced: 2025-01-16T07:26:29.560Z (5 months ago)
- Topics: actions, ddlc, github-actions, mas, modding, monika, monika-after-story, reusable-workflow, submodding
- Homepage:
- Size: 104 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 🔧 Submod Check
A [reusable workflow][1] that you can use to pre-emptively perform submod syntax
and `init` block tests on every push.
## 📗 Example usage
1. Create a file called `check.yml` (any name works, it only serves as a note
for you and other users to distinguish workflows) in a directory
`.github/workflows`. Populate it with the following content:
```yml
name: Run checks
on: push
jobs:
check:
uses: friends-of-monika/submod-check/.github/workflows/check.yml@master
with:
paths: |-
PATH_TO_YOUR_SUBMOD_DIRECTORY
```
2. Replace `PATH_TO_YOUR_SUBMOD_DIRECTORY` with a path (relative to repository
root) to the directory where your submod's .rpy files are located. For example,
imagine you have a directory called `mod` in your repository where all script
files reside, in this case, you'd set `paths` value to the following:
```yml
paths: |-
mod
```
3. Commit and push the changes.
[1]: https://docs.github.com/en/actions/using-workflows/reusing-workflows#reusable-workflows-and-starter-workflows