stateful / runme-action

A GitHub action to run Runme in CI.

Runme GitHub Action

A GitHub Action to run Runme in CI. Instead of calling commands and scripts directly as part of your CI step, link existing code snippets from your project documentation into the CI execution to ensure that they stay up to date and valid. It binds documentation snippets with your CI/CD process and helps validate correctness of your project documentation.

The action is powered by Runme which is a tool that helps you supercharge your markdown files.

Note: Runme is not yet supported on Windows, see stateful/runme#173 for status updates.

Example

Given you have a markdown file that contains one or several set-up scripts, e.g.

## Setup

### Install Dependencies

As a first step, please install the project dependencies via:

```sh {"name":"installDeps"}
npm install
```

### Build Project

To build project files and test the project, run:

```sh {"name":"build"}
npm run compile
npm run build
```

### Run Tests

To run all tests, execute:

```sh {"name":"tests"}
npx eslint
npx vitest
npx wdio run ./wdio.conf.js
```

...

You can run these documented commands in CI using Runme via:

jobs:
  test:
    runs-on: ubuntu-latest
    name: Action Test
    steps:
      - uses: stateful/runme-action@v2
        with:
          workflows: installDeps

or run multiple sections in order:

jobs:
  test:
    runs-on: ubuntu-latest
    name: Action Test
    steps:
      - name: Setup / Test Project
        uses: stateful/runme-action@v2
        with:
          # enable to run workflows in parallel
          # parallel: true
          workflows: |
            installDeps
            build
            tests

Inputs

workflows:

List of workflow commands to execute.

Required: true Example:

- name: Setup / Test Project
  uses: stateful/runme-action@v2
  with:
    workflows: |
      installDeps
      build
      tests

version:

Defines which Runme version to use. You can find all Runme release on GitHub.

Default: latest
Example: v1.2.4

parallel:

If set to true, Runme will run these commands in parallel.

Default: false

Contributing & Feedback

Let us know what you think via GitHub issues or submit a PR. Join the conversation on Discord. We're looking forward to hear from you.

LICENCE

Apache License, Version 2.0