configure ci

.editorconfig

@@ -0,0 +1,22 @@
+# https://editorconfig.org/
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+
+[*.py]
+indent_style = space
+indent_size = 4
+max_line_length = 120
+trim_trailing_whitespace = true
+
+[*.yaml]
+indent_style = space
+indent_size = 4
+
+[*.yml]
+indent_style = space
+indent_size = 4

.github/workflows/check.yml

@@ -0,0 +1,114 @@
+# This workflow runs whenever a PR is opened or updated, or a commit is pushed to main. It runs
+# several checks:
+# - fmt: checks that the code is formatted according to rustfmt
+# - clippy: checks that the code does not contain any clippy warnings
+# - doc: checks that the code can be documented without errors
+# - hack: check combinations of feature flags
+# - msrv: check that the msrv specified in the crate is correct
+permissions:
+  contents: read
+  # This configuration allows maintainers of this repo to create a branch and pull request based on
+  # the new branch. Restricting the push trigger to the main branch ensures that the PR only gets
+  # built once.
+on:
+  push:
+    branches: [main]
+  pull_request:
+  merge_group:
+  # If new code is pushed to a PR branch, then cancel in progress workflows for that PR. Ensures that
+  # we don't waste CI time, and returns results quicker https://github.com/jonhoo/rust-ci-conf/pull/5
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+name: check
+jobs:
+  fmt:
+    runs-on: ubuntu-latest
+    name: stable / fmt
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Install stable
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt
+      - name: cargo fmt --check
+        run: cargo fmt --check
+  clippy:
+    runs-on: ubuntu-latest
+    name: ${{ matrix.toolchain }} / clippy
+    permissions:
+      contents: read
+      checks: write
+    strategy:
+      fail-fast: false
+      matrix:
+        # Get early warning of new lints which are regularly introduced in beta channels.
+        toolchain: [stable, beta]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Install ${{ matrix.toolchain }}
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ matrix.toolchain }}
+          components: clippy
+      - name: cargo clippy
+        uses: giraffate/clippy-action@v1
+        with:
+          reporter: "github-pr-check"
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+  doc:
+    # run docs generation on nightly rather than stable. This enables features like
+    # https://doc.rust-lang.org/beta/unstable-book/language-features/doc-cfg.html which allows an
+    # API be documented as only available in some specific platforms.
+    runs-on: ubuntu-latest
+    name: nightly / doc
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Install nightly
+        uses: dtolnay/rust-toolchain@nightly
+      - name: cargo doc
+        run: cargo doc --no-deps --all-features
+        env:
+          RUSTDOCFLAGS: --cfg docsrs
+  hack:
+    # cargo-hack checks combinations of feature flags to ensure that features are all additive
+    # which is required for feature unification
+    runs-on: ubuntu-latest
+    name: ubuntu / stable / features
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Install stable
+        uses: dtolnay/rust-toolchain@stable
+      - name: cargo install cargo-hack
+        uses: taiki-e/install-action@cargo-hack
+      # intentionally no target specifier; see https://github.com/jonhoo/rust-ci-conf/pull/4
+      # --feature-powerset runs for every combination of features
+      - name: cargo hack
+        run: cargo hack --feature-powerset check
+  msrv:
+    # check that we can build using the minimal rust version that is specified by this crate
+    runs-on: ubuntu-latest
+    # we use a matrix here just because env can't be used in job names
+    # https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability
+    strategy:
+      matrix:
+        msrv: ["1.74"] # 2021 edition requires 1.56
+    name: ubuntu / ${{ matrix.msrv }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Install ${{ matrix.msrv }}
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ matrix.msrv }}
+      - name: cargo +${{ matrix.msrv }} check
+        run: cargo check

.github/workflows/scheduled.yml

@@ -0,0 +1,59 @@
+# Run scheduled (rolling) jobs on a nightly basis, as your crate may break independently of any
+# given PR. E.g., updates to rust nightly and updates to this crates dependencies. See check.yml for
+# information about how the concurrency cancellation and workflow triggering works
+permissions:
+    contents: read
+on:
+    push:
+      branches: [main]
+    pull_request:
+    schedule:
+      - cron:  '7 7 * * *'
+concurrency:
+    group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+    cancel-in-progress: true
+name: rolling
+jobs:
+    # https://twitter.com/mycoliza/status/1571295690063753218
+    nightly:
+      runs-on: ubuntu-latest
+      name: ubuntu / nightly
+      steps:
+        - uses: actions/checkout@v4
+          with:
+            submodules: true
+        - name: Install nightly
+          uses: dtolnay/rust-toolchain@nightly
+        - name: cargo generate-lockfile
+          if: hashFiles('Cargo.lock') == ''
+          run: cargo generate-lockfile
+        - name: cargo test --locked
+          run: cargo test --locked --all-features --all-targets
+    # https://twitter.com/alcuadrado/status/1571291687837732873
+    update:
+      # This action checks that updating the dependencies of this crate to the latest available that
+      # satisfy the versions in Cargo.toml does not break this crate. This is important as consumers
+      # of this crate will generally use the latest available crates. This is subject to the standard
+      # Cargo semver rules (i.e cargo does not update to a new major version unless explicitly told
+      # to).
+      runs-on: ubuntu-latest
+      name: ubuntu / beta / updated
+      # There's no point running this if no Cargo.lock was checked in in the first place, since we'd
+      # just redo what happened in the regular test job. Unfortunately, hashFiles only works in if on
+      # steps, so we repeat it.
+      steps:
+        - uses: actions/checkout@v4
+          with:
+            submodules: true
+        - name: Install beta
+          if: hashFiles('Cargo.lock') != ''
+          uses: dtolnay/rust-toolchain@beta
+        - name: cargo update
+          if: hashFiles('Cargo.lock') != ''
+          run: cargo update
+        - name: cargo test
+          if: hashFiles('Cargo.lock') != ''
+          run: cargo test --locked --all-features --all-targets
+          env:
+            RUSTFLAGS: -D deprecated
+