mirror of
https://github.com/dsec-hub/dsec-discord-bot.git
synced 2026-09-22 15:53:56 +00:00
345f4ec513
* SEC-01: add pull-request CI and stop the deploy leaving DOT_ENV on the VPS A merge to main runs the merged commit as root on the club VPS through the self-hosted runner, and this repo has no PR CI, no required review and no status check. - .github/workflows/ci.yml: fmt / clippy / build --locked / test on ubuntu-latest, contents: read, both actions pinned by commit SHA. Never the VPS. - deploy.yml: keep push to main, add workflow_dispatch, permissions contents: read, environment: production, and an if: always() step that removes the .env the deploy writes into the workspace. - .dockerignore: keep that .env, target/ and .git out of the build context. - Dockerfile: --locked on both cargo build --release lines. environment: production gates nothing until required reviewers are configured on the environment itself, and the ruleset still requires zero approving reviews. Both are owner-only and listed in the pull request. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * SEC-01: make cargo fmt and clippy clean so the CI job can go green The CI workflow added in #5 fails on code that predates it: three files were unformatted and `cargo clippy --all-targets -- -D warnings` reported 26 errors. A red check cannot be made a required status check on the protect-main ruleset, which is what this unblocks. `cargo fmt --all` over three files, and 26 clippy errors resolved: 18 via `cargo clippy --all-targets --fix`, the rest by hand. Two fixes uncovered lints that had been masked (an `unnecessary_unwrap` in info.rs behind the needless borrow on the line above, and two `unnecessary_to_owned` at the call sites of a signature that moved from `&String` to `&str`), so 28 fixes for 26 warnings. Three `#[allow]`s where the only real fix would change a signature or a public API: `result_large_err` on `AppState::new` (the large variant is `supabase::Error`, owned by supabase-lib-rs) and `too_many_arguments` on `log_embed` and on the `embed` slash command. No behaviour change. src/ only; .github/, Dockerfile, .dockerignore, Cargo.toml and Cargo.lock are untouched. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * SEC-01: pin actions/checkout in the deploy workflow to a commit SHA deploy.yml runs on the self-hosted VPS runner with passwordless sudo, so a mutable tag on this action is a code-execution path onto that host if the tag is ever moved. Pinned to the commit v4 currently resolves to (11d5960a326750d5838078e36cf38b85af677262), verified against upstream — this is the same code the deploy already runs today, not a version bump. ci.yml is on v7.0.1; the deploy path is deliberately left on v4 so that pinning does not smuggle a major-version change into a workflow whose only test is a live deploy. Raised by Codex review of PR #5 as the one unpinned `uses:` in either workflow. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
82 lines
3.1 KiB
YAML
82 lines
3.1 KiB
YAML
# Format, lint, build and test on every pull request.
|
|
#
|
|
# This must run on a GitHub-hosted runner and never on the club VPS. The runner
|
|
# deploy.yml uses lives on the club's own server and executes whatever a workflow
|
|
# tells it to, as root, so nothing triggered by a pull request may be pointed at
|
|
# it. Read that as a rule for this file, not a property of the repository: this
|
|
# repo is public, forking is on, and fork pull requests only need approval from a
|
|
# first-time contributor, so a fork that brings its own workflow can still reach
|
|
# that runner. See SEC-01.
|
|
#
|
|
# SEC-01: point the protect-main ruleset's required status check at this job's
|
|
# name ("fmt / clippy / build / test") so a red build blocks the merge that
|
|
# deploys.
|
|
|
|
name: CI
|
|
|
|
on:
|
|
pull_request:
|
|
|
|
# A newer push to the same pull request makes an in-flight run irrelevant.
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
check:
|
|
name: fmt / clippy / build / test
|
|
runs-on: ubuntu-latest
|
|
# A cold build of this dependency tree (serenity, reqwest, image, exr) in
|
|
# release, then clippy, then test, is slow on a 4-vCPU hosted runner. This is
|
|
# a guard against a hung job, not a target.
|
|
timeout-minutes: 45
|
|
|
|
steps:
|
|
# Third-party and first-party actions alike are pinned to a full commit
|
|
# SHA: a tag is mutable and can be repointed at new code by whoever owns
|
|
# the action.
|
|
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
|
|
# Caches written by a pull_request run are scoped to that pull request, so
|
|
# this pays off across pushes to the same branch rather than across branches.
|
|
- name: Cache cargo registry and build artifacts
|
|
uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
|
|
with:
|
|
path: |
|
|
~/.cargo/registry
|
|
~/.cargo/git
|
|
target
|
|
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-cargo-
|
|
|
|
# actions/runner-images documents rustfmt for ubuntu-24.04 but not clippy (it
|
|
# lists clippy only under ubuntu-22.04), while the image actually in use does
|
|
# ship it. Adding both components is a no-op when they are present and keeps
|
|
# this job working if that undocumented extra ever goes away. Print the
|
|
# versions too: clippy's lint set moves between releases, so knowing which one
|
|
# ran is what explains a lint that appeared from nowhere.
|
|
- name: Toolchain
|
|
run: |
|
|
rustup component add clippy rustfmt
|
|
cargo --version
|
|
cargo fmt --version
|
|
cargo clippy --version
|
|
|
|
- name: Format
|
|
run: cargo fmt --all -- --check
|
|
|
|
# Kept ahead of clippy and test: those resolve dependencies and would
|
|
# refresh Cargo.lock in place, so a stale lockfile would slip past
|
|
# --locked if they ran first.
|
|
- name: Build
|
|
run: cargo build --locked --release
|
|
|
|
- name: Clippy
|
|
run: cargo clippy --all-targets -- -D warnings
|
|
|
|
- name: Test
|
|
run: cargo test
|