Common CI workflows

This goal of this repo is to define standardized GitHub Actions workflows to be used in Status projects for common tasks like testing and documentation generation.

For testing, there is common.yml that provides commonly required steps:

• setting up the build matrix (different OSes, different Nim versions)
• installing the build dependencies
• building Nim and Nimble
• running the tests

For docs, there is docs.yml that sets up mdBook and Nim, builds and publishes the docs to GitHub Pages.

Table of Contents

• Common CI workflows
  • common.yml usage
    • The test command
    • Nim version
    • Nimble version
  • docs.yml usage
    • The docs command
    • mdBook version and preprocessors
    • Nim version
    • Branch and directory to publish

common.yml usage

To use this workflow, in the project's .github/workflows/<name>.ymlyou need to refer to it inside of jobs.<name>.uses field.
For example, the full file might look like this:

name: CI
on:
  push:
    branches:
      - master
  pull_request:
  workflow_dispatch:

jobs:
  build:
    uses: status-im/nimbus-common-workflow/.github/workflows/common.yml@main

By default, it is assumed that your project uses nimble test for its testing.

The test command

In a case where you don't just run nimble test, or when you need some additional commands (e.g. installing additional libraries) before running the tests, you can specify the jobs.<name>.with.test-command.
For example:

name: CI
on:
  push:
    branches:
      - master
  pull_request:
  workflow_dispatch:

jobs:
  build:
    uses: status-im/nimbus-common-workflow/.github/workflows/common.yml@main
    with:
      test-command: |
          nimble install -y toml_serialization json_serialization unittest2
          nimble test

Or to run several different test commands:

name: CI
on:
  push:
    branches:
      - master
  pull_request:
  workflow_dispatch:

jobs:
  build:
    uses: status-im/nimbus-common-workflow/.github/workflows/common.yml@main
    with:
      test-command: |
          nimble install -y libbacktrace
          nimble test
          nimble test_libbacktrace
          nimble examples

Nim version

By default, this workflow tests a package with the following Nim versions:

• version-2-0
• version-2-2
• version-2-4
• devel

To test with a different set of Nim versions, specify them in jobs.<name>.with.nim-versions using the following syntax (make sure to include both outer single quotes and inner double quotes as in the example):

name: CI
on:
  push:
    branches:
      - master
  pull_request:
  workflow_dispatch:

jobs:
  build:
    uses: status-im/nimbus-common-workflow/.github/workflows/common.yml@main
    with:
      nim-versions: '["version-2-0", "version-2-2"]'

Nimble version

If you need to override the default Nimble version, you can do it by specifying it with jobs.<name>.with.nimble-version:

name: CI
on:
  push:
    branches:
      - master
  pull_request:
  workflow_dispatch:

jobs:
  build:
    uses: status-im/nimbus-common-workflow/.github/workflows/common.yml@main
    with:
      nimble-version: 'a399f502dec7ffcd905c1cf54b13274ad990bada'

You can find Nimble releases here.

 

 

docs.yml usage

Similarly to common.yml, to use this workflow, refer to it in your project's .github/workflows/<name>.yml:

name: Build Docs

on:
  push:
    branches:
      - master
  workflow_dispatch:

jobs:
  docs:
    uses: status-im/nimbus-common-workflow/.github/workflows/docs.yml@main

By default, it is assumed that your project uses nimble docs to generate the docs.

The docs command

You can customize the command used to produce the docs by defining docs-command value:

name: Build Docs
on:
  push:
    branches:
      - master
  workflow_dispatch:

jobs:
  docs:
    uses: status-im/nimbus-common-workflow/.github/workflows/docs.yml@main
    with:
      docs-command: |
          nimble install nimble@#head -y
          nimble doc --outdir:docs/apidocs --project --index:on src/myproject.nim"
          mdbook build book -d docs

mdBook version and preprocessors

By default, this workflow uses the latest mdBook and no preprocessors to build the docs.

To pin the mdBook version, set mdbook-version:

name: Build Docs

on:
  push:
    branches:
      - master
  workflow_dispatch:

jobs:
  docs:
    uses: status-im/nimbus-common-workflow/.github/workflows/docs.yml@main
    with:
      mdbook-version: "0.5.2"

If your documentation requires mdBook preprocessors, list them as a JSON array in mdbook-preprocessors:

name: Build Docs

on:
  push:
    branches:
      - master
  workflow_dispatch:

jobs:
  docs:
    uses: status-im/nimbus-common-workflow/.github/workflows/docs.yml@main
    with:
      mdbook-version: "0.5.2"
      mdbook-preprocessors: >-
        [
          "mdbook-open-on-gh@3.0.0",
          "mdbook-toc@0.15.3",
          "mdbook-admonish@1.20.0"
        ]

You can list the preprocessors with specific versions or without them (then the latest version will be installed).

Nim version

By default, the latest stable Nim version is installed.

You can override that with nim-version:

name: Build Docs

on:
  push:
    branches:
      - master
  workflow_dispatch:

jobs:
  docs:
    uses: status-im/nimbus-common-workflow/.github/workflows/docs.yml@main
    with:
      nim-version: "0.5.2"

This can be handy if you run Nim code during documentation build (e.g. "nim doc") and your project requires a specific Nim version.

Branch and directory to publish

By default, this workflow will publish the docs from ./docs directory to gh-pages branch.

If your docs-command puts the generated docs into a different directory or you want to publish from a different branch, use publish-dir and publish-branch:

name: Build Docs

on:
  push:
    branches:
      - master
  workflow_dispatch:

jobs:
  docs:
    uses: status-im/nimbus-common-workflow/.github/workflows/docs.yml@main
    with:
      publish-dir: "./book"
      publish-branch: "documentation"