Skip to content

Commit c5746e5

Browse files
authored
docs: update agent instructions (#49)
1 parent 67f7477 commit c5746e5

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

AGENTS.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,10 @@ pre-commit install
134134
pre-commit run -a
135135
```
136136

137+
### 4.3 Updating all dependencies
138+
139+
You need to keep the project dependencies fresh from time to time. The way to do so is automated with `just bump`. Keep in mind that for that command to work, you need to have `nix` installed and in the $PATH.
140+
137141
## 5. MCP Tools & Permissions
138142

139143
The handler filters tools dynamically based on the Sysdig user's permissions. Each tool declares mandatory permissions via `WithRequiredPermissions`.
@@ -262,7 +266,27 @@ All commit messages must follow the [Conventional Commits](https://www.conventio
262266
**Problem**: Pre-commit hooks not running
263267
- **Solution**: Run `pre-commit install` to install git hooks, then `pre-commit run -a` to test all files.
264268

265-
## 11. Reference Links
269+
## 11. Releasing
270+
271+
The workflow in .github/workflows/publish.yaml will create a new release automatically when the version of the crate changes in package.nix in the default git branch.
272+
So, if you attempt to release a new version, you need to update this version. You should try releasing a new version when you do any meaningful change that the user can benefit from.
273+
The guidelines to follow would be:
274+
275+
* New feature is implemented -> Release new version.
276+
* Bug fixes -> Release new version.
277+
* CI/Refactorings/Internal changes -> No need to release new version.
278+
* Documentation changes -> No need to release new version.
279+
280+
The current version of the project is not stable yet, so you need to follow the [Semver spec](https://semver.org/spec/v2.0.0.html), with the following guidelines:
281+
282+
* Unless specified, do not attempt to stabilize the version. That is, do not try to update the version to >=1.0.0. Versions for now should be <1.0.0.
283+
* For minor changes, update only the Y in 0.X.Y. For example: 0.5.2 -> 0.5.3
284+
* For major/feature changes, update the X in 0.X.Y and set the Y to 0. For example: 0.5.2 -> 0.6.0
285+
286+
After the commit is merged into the default branch the workflow will cross-compile the project and create a GitHub release of that version.
287+
Check the workflow file in case of doubt.
288+
289+
## 12. Reference Links
266290

267291
- `README.md` – Comprehensive product docs, quickstart, and client configuration samples.
268292
- `CLAUDE.md` – Complementary guide with additional examples and command reference.

justfile

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,14 @@ generate:
2525
test-coverage: generate
2626
go test -coverprofile=coverage.out ./...
2727

28+
# Bump all dependencies
2829
bump:
2930
nix flake update
3031
nix develop --command go get -u -t -v ./...
3132
nix develop --command go mod tidy
3233
nix develop --command just rehash-package-nix
3334
nix develop --command pre-commit autoupdate
3435

35-
36+
# Re-calculate the vendorHash from the package.nix
3637
rehash-package-nix:
3738
sd 'vendorHash = ".*";' 'vendorHash = "";' package.nix; h="$((nix build -L --no-link .#default || true) 2>&1 | sed -nE 's/.*got:[[:space:]]+([^ ]+).*/\1/p' | tail -1)"; [ -n "$h" ] && sd 'vendorHash = ".*";' "vendorHash = \"$h\";" package.nix && echo "vendorHash -> $h"

0 commit comments

Comments
 (0)