You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+25-1Lines changed: 25 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -134,6 +134,10 @@ pre-commit install
134
134
pre-commit run -a
135
135
```
136
136
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
+
137
141
## 5. MCP Tools & Permissions
138
142
139
143
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
262
266
**Problem**: Pre-commit hooks not running
263
267
-**Solution**: Run `pre-commit install` to install git hooks, then `pre-commit run -a` to test all files.
264
268
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
266
290
267
291
-`README.md` – Comprehensive product docs, quickstart, and client configuration samples.
268
292
-`CLAUDE.md` – Complementary guide with additional examples and command reference.
0 commit comments