Skip to content

Commit 0cc9fce

Browse files
committed
docs: PR merge comment, coverage, mutation baseline; gitignore eval/mutants
- release-process: document PR merge comment workflow, add automation row - gh-automation: describe CI (nextest, coverage/Codecov, PR merge comment) - mutation-testing: state allowed-missed baseline (15) - gitignore: mutants.out, eval/*.json, eval/artifacts, .diffscope.eval-trend Made-with: Cursor
1 parent 20e7c2b commit 0cc9fce

File tree

4 files changed

+15
-1
lines changed

4 files changed

+15
-1
lines changed

.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@ Thumbs.db
2323
*.patch
2424
comments.json
2525
review.md
26+
mutants.out/
27+
mutants.out.old/
28+
29+
# Eval and trends
30+
eval/*.json
31+
eval/artifacts/
32+
.diffscope.eval-trend.json
2633

2734
# Docker
2835
.dockerignore

docs/gh-automation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,11 @@ gh workflow run "Prepare release" -f version=0.5.28
7676

7777
## CI and runs
7878

79+
- **Lint**: actionlint, frontend build, `cargo fmt`, `cargo clippy`.
80+
- **Test**: `cargo nextest run` on ubuntu/macos/windows.
81+
- **Coverage**: `cargo llvm-cov` → upload to Codecov. Set repo secret `CODECOV_TOKEN` to enable uploads; CI does not fail if missing.
82+
- **PR merge comment**: When a PR is merged, a workflow comments on each issue linked via “Closes #N”, “Fixes #N”, or “Resolves #N” in the PR body.
83+
7984
```bash
8085
# Download artifacts from latest run
8186
gh run download

docs/mutation-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@ To re-run: `cargo mutants -f '*state*'` and `cargo mutants -f '*storage_pg*'` (a
5656

5757
## CI
5858

59-
The `mutation` job in `.github/workflows/ci.yml` runs mutation on the `storage_json` crate with a timeout. Update the "allowed missed" baseline in the job when you intentionally accept new equivalent mutants (and add them to the table above).
59+
The `mutation` job in `.github/workflows/ci.yml` runs mutation on the `storage_json` crate with a timeout. The current **allowed-missed baseline is 15**. Update the baseline in the workflow (and optionally this doc) when you intentionally accept new equivalent mutants (and add them to the table above).

docs/release-process.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ This doc and GitHub Actions make releases repeatable with minimal manual steps.
3636

3737
- Use the **PR template** (Summary, Test plan, **Closes #N**).
3838
- Linking “Closes #28” in the PR body auto-closes the issue when the PR is merged.
39+
- When the PR is merged, the **PR merge — comment on linked issues** workflow posts a comment on each linked issue (Closes/Fixes/Resolves #N).
3940

4041
## Automation summary
4142

@@ -46,3 +47,4 @@ This doc and GitHub Actions make releases repeatable with minimal manual steps.
4647
| Release body | **Release** workflow reads `RELEASE_NOTES.md` for the tagged version. |
4748
| Binaries + Docker | **Release** workflow builds and uploads. |
4849
| Issue close | Add “Closes #N” in PR body. |
50+
| PR merge → issue comment | **PR merge — comment on linked issues** workflow comments on each linked issue when the PR is merged. |

0 commit comments

Comments
 (0)