Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/dev-security.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# The automated security review that stands in for a second developer on dev (policy rule 3).
# Other repositories call it from a pull_request workflow; dependency review needs a pull request's base and head.
name: dev-security
on:
pull_request:
workflow_call:

permissions: {}

Expand Down
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ same release controls as the projects it publishes.
| Workflow | Purpose |
|---|---|
| `python-tests.yml`, `python-versions.yml`, `rust-tests.yml` | Test matrices |
| `dev-security.yml` | Dependency review and workflow lint (`actionlint`, `zizmor`), the security checks `dev` requires |
| `stable-guard.yml` | Checks a pull request into `stable` is release-ready: a MAJOR.MINOR.PATCH version, matching chart versions, no git dependencies |
| `release-check.yml` | Runs on `stable` only: reads the version, refuses a partly published release, checks merged-PR provenance and that the `release` environment is protected |
| `maturin-wheels.yml`, `crates.yml`, `docker.yml` | Build and publish artifacts |
Expand All @@ -29,6 +30,21 @@ jobs:
Use the SHA of a `v*` tag of this repository, never a branch. Tags here are created only by the release
App and can't be moved or deleted, so a version comment always matches its SHA.

Call `dev-security.yml` from a workflow that runs on `pull_request`, with a job named `dev-security`, so the
checks a `dev` ruleset requires are `dev-security / dependency-review` and `dev-security / workflow-lint`:

```yaml
on:
pull_request:

permissions:
contents: read

jobs:
dev-security:
uses: blacklanternsecurity/release-workflows/.github/workflows/dev-security.yml@<full sha of the tag> # v1.1.0
```

`release-check.yml` and `publish.yml` read the release App key in jobs that run in the caller's `release`
environment. A reusable workflow gets an environment secret only when the caller passes it, so map it by
name as above, alongside any other secrets such as `registry-token`. The caller's own job can't read the
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "release-workflows"
version = "1.0.0"
version = "1.1.0"
requires-python = ">=3.11"
dependencies = ["packaging", "pyyaml"]

Expand Down
2 changes: 1 addition & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading