jcoffey-dev
a63839f6b0
SPEC 2.2a says INBUXA writes its own when the repository is first published, and it is. Until now the public repository carried Stalwart's: a security policy telling people to report vulnerabilities to Stalwart Labs, and a contributing guide whose policy is that pull requests from anyone not on upstream's vouched list are closed automatically. Neither is this project's, and both were being offered to anyone who looked. So: a security policy that says where to send a report, and what happens if it turns out to be upstream's bug rather than ours; a contributing guide that says what a fork of someone else's code needs from a contributor, including the clean-room question, since the record has to stay true; the Contributor Covenant; and a sponsor link. Upstream's two security documents move to .github-upstream/ beside its workflows -- kept, not used, not presented as ours. CI builds the server and compiles every test target, and deliberately runs no suite. The unit tests only build with the integration crate in the graph, and the integration suites want a STORE, fixed ports and a container apiece, so running them here would mean a tick that skipped everything or a cross that means "the runner has no Redis". The workflow says as much, so nobody has to rediscover it. Also ignores /artifact: two hand-built binaries, ~190 MB, one `git add -A` away from a public repository.
52 lines
2.5 KiB
YAML
52 lines
2.5 KiB
YAML
# What CI can check without a mail server's worth of infrastructure.
|
|
#
|
|
# The build, and that every test target compiles. It deliberately does not
|
|
# *run* the test suites: the unit tests only build with the integration crate
|
|
# in the graph, because that is what switches on the `test_mode` features they
|
|
# rely on (docs/spec/SPEC.md 2.2b), and the integration suites need a `STORE`,
|
|
# fixed ports, and in most cases a container apiece (docs/spec/
|
|
# container-tests.md). Running them here would mean either a green tick that
|
|
# skipped everything, or a red one that means "the runner has no Redis".
|
|
#
|
|
# So this catches what it can honestly catch -- code that does not compile,
|
|
# including test code -- and the suites are run by hand, one at a time, as
|
|
# that page describes. If that changes, it changes because someone made the
|
|
# suites runnable unattended, not because CI started ignoring failures.
|
|
name: CI
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
pull_request:
|
|
# Lets CI be run by hand against any ref, including one that predates a CI
|
|
# change, without pushing an empty commit to move it.
|
|
workflow_dispatch:
|
|
|
|
# A second push to a branch cancels the run still going for the first: the
|
|
# older run's answer is about code nobody is looking at any more.
|
|
concurrency:
|
|
group: ci-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
# Every `uses:` here is pinned to a full commit SHA, with the release it
|
|
# belongs to in the trailing comment. A tag is a mutable pointer, so
|
|
# trusting `@v7` is trusting every future version of that action,
|
|
# including one pushed by whoever compromises the account. Dependabot
|
|
# updates both halves together -- do not "simplify" a pin back to a tag.
|
|
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
- uses: Swatinem/rust-cache@49a0bdc70d2e1b713ca9e2869b211fcce03d3c1c # v2.9.2
|
|
- name: System dependencies
|
|
# foundationdb and the search backends are off by default, but the
|
|
# default feature set still links against the system's C libraries.
|
|
run: sudo apt-get update && sudo apt-get install -y --no-install-recommends clang
|
|
- name: Build the server
|
|
run: cargo build -p inbuxa --locked
|
|
- name: Compile every test target
|
|
# `--no-run` is the point: it builds the unit tests and the integration
|
|
# crate together, which is the combination that resolves the test
|
|
# features, and stops short of running anything that wants a store.
|
|
run: cargo test --workspace --locked --no-run
|