Skip to content

Commit df7cbbf

Browse files
committed
chore
1 parent 3f43ddd commit df7cbbf

5 files changed

Lines changed: 34 additions & 39 deletions

File tree

.github/dependabot.yml

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,26 @@
1-
# WHY: Automatically updates GitHub Actions to latest versions
2-
# OBS: Runs monthly to keep actions secure and up-to-date
3-
# REQ: Keep this file to maintain security patches in workflows
1+
# ============================================================
2+
# .github/dependabot.yml (Check for GitHub Actions updates)
3+
# ============================================================
4+
# SOURCE: https://github.com/denisecase/templates
5+
#
6+
# REQ.PROJECT: This repository SHOULD track GitHub Actions updates automatically.
7+
# WHY-FILE: GitHub Actions are executable dependencies and may receive security or behavior updates.
8+
# OBS: Language-level dependencies (e.g., Python packages) are upgraded manually.
9+
# OBS: GitHub Actions are the only dependency class automated here.
10+
# ALT: Dependabot could be omitted if workflows are pinned and reviewed manually.
11+
# CUSTOM: Update interval if CI cadence or security posture changes.
412

5-
version: 2
13+
# NOTE: This file automatically updates the versions used in Actions workflows.
14+
# You don't need to modify this file.
15+
# To disable: Delete this file or set enabled: false below.
16+
# enabled: false # Uncomment to disable Dependabot
17+
18+
version: 2 # Dependabot configuration version
619

720
updates:
8-
- package-ecosystem: "github-actions" # WHY: Updates action versions in workflows
9-
directory: "/" # WHY: Scan all .github/workflows/*.yml files
21+
- package-ecosystem: "github-actions" # Dependency type
22+
directory: "/" # Location of GitHub Actions workflows
1023
schedule:
11-
interval: "monthly" # WHY: Monthly updates balance freshness vs notification noise
24+
interval: "monthly" # ALT: Use "weekly" for higher security when needed
1225
commit-message:
13-
prefix: "ci(deps)" # WHY: Conventional commit format for changelog tools
26+
prefix: "(deps)" # WHY: enable filtering by commit type

.yamllint.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# ============================================================
2+
# .yamllint.yml (YAML linting configuration)
3+
# ============================================================
4+
15
# WHY: Enforce YAML correctness without arbitrary style constraints.
26
# OBS: Default yamllint rules conflict with GitHub Actions YAML.
37
# Line length, document start, truthy, and comment spacing are intentionally disabled.

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2025 Denise M. Case
3+
Copyright (c) 2025-2026 Denise M. Case
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -26,29 +26,6 @@ lake build
2626
lake exe verify
2727
```
2828

29-
## Developer (running pre-commit)
30-
31-
Pre-commit is optional; CI will report exact commands if it fails.
32-
33-
Steps to run pre-commit locally. Install `uv`.
34-
35-
Initialize once:
36-
37-
```shell
38-
uv self update
39-
uvx pre-commit install
40-
uvx pre-commit run --all-files
41-
```
42-
43-
Save progress as needed:
44-
45-
```shell
46-
git add -A
47-
# If pre-commit makes changes, re-run `git add -A` before committing.
48-
git commit -m "update"
49-
git push -u origin main
50-
```
51-
5229
## Documentation
5330

5431
- [Paper to Lean Mapping](./docs/MAPPING.md)

lychee.toml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1+
# ============================================================
2+
# lychee.toml (Lychee link checker configuration)
3+
# ============================================================
4+
5+
# REQ.PROJECT: Automatic link checking using GitHub Actions and Lychee.
16
# WHY-FILE: Shared Lychee configuration (lychee.toml) for documentation-heavy repositories.
2-
# REQ.PROJECT: Link checking MUST be non-flaky and CI-safe.
7+
# REQ: Link checking MUST be reliable and CI-safe.
38
# WHY: Configures Lychee link checker behavior for CI/CD.
49
# OBS: Flat structure required by lychee v0.22+; no nested sections.
510
# OBS: No path exclusions; all documentation files are expected to be link-clean.
6-
# OBS: Link integrity supports Structural Explainability (SE)
7-
# by preserving stable, reconstructible references over time.
8-
# OBS: Link integrity also benefits Contextual Evidence & Explanations (CEE)
9-
# by maintaining the availability of cited evidence and provenance,
10-
# without enforcing interpretation.
11-
11+
# OBS: Link integrity preserves stable, reconstructible references over time.
12+
# OBS: Link integrity maintains connections to external resources.
1213

1314
# WHY: Control verbosity and CI-friendly output
1415
verbose = "info" # WHY: Balance between detail and noise

0 commit comments

Comments
 (0)