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.

🔧 Submod Check

A reusable workflow 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:

   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:

   paths: |-
     mod

3. Commit and push the changes.