Runme offers a convenient GitHub action that seamlessly integrates the tool into your CI/CD pipeline. By re-using the workflows your contributors use in CI/CD, you can ensure that your contribution guidelines are up-to-date and still relevant.
.github/workflows/test.yaml create a new file with the following contents:
name: Test Changes
on: [push, pull_request]
- name: Clone Repository
- name: Setup Node version
- name: Install dependencies
run: npm ci
# execute workflows through Runme
- name: Build / Test Project
Now, you can define what should be done for building and testing your project in e.g. a
CONTRIBUTING.md and have your contributors be able to run the same flows through the CLI, e.g. via:
runme run build test.