Skip to content

Improve diffbudget release documentation #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rogerchappel wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve diffbudget release documentation #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bfd12c9
Include security policy in package
rogerchappel Jun 8, 2026
6fae9e9
Document alias and release checks
rogerchappel Jun 8, 2026
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
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ npx diffbudget init
# score uncommitted changes against HEAD
npx diffbudget scan --base HEAD --output .diffbudget/latest

# short alias for the same CLI
npx dbudget scan --base HEAD --output .diffbudget/latest

# fail with exit code 2 when the patch exceeds budget
npx diffbudget scan --base HEAD --strict

Expand Down Expand Up @@ -105,6 +108,8 @@ npm test
npm run check
npm run build
npm run smoke
npm run package:smoke
npm run release:check
bash scripts/validate.sh
```

Expand Down
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
"files": [
"dist",
"README.md",
"LICENSE"
"LICENSE",
"SECURITY.md"
],
"scripts": {
"build": "tsc",
Expand Down