Skip to content

Document topic-branch PRs into develop (match pgwd/gghstats) #9

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

Merged
hrodrig merged 1 commit into from
Sep 12, 2026
Merged

Document topic-branch PRs into develop (match pgwd/gghstats) #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ This repository is the **GROOT product**: CLI, collector engine, behavior contra

For Helm, in-cluster CronJob, `docker run` with kubeconfig, and standalone scheduling, link to **[groot-selfhosted](https://github.com/hrodrig/groot-selfhosted)** (`run/README.md`). On-demand collect: **[groot-trigger](https://github.com/hrodrig/groot-trigger)**. VPS archive door: **[groot-share](https://github.com/hrodrig/groot-share)**; gfs deploy: **[groot-share-selfhosted](https://github.com/hrodrig/groot-share-selfhosted)**.

## Git flow

- Work on **topic branches** opened from `develop`; merge via **PR into `develop`**. **Never** commit or push directly to `develop` or `main`.
- Release: **PR `develop` → `main`**, then annotated tag on `main` (GoReleaser). After every merge into `main`, sync **`main` → `develop`** (see `.cursor/rules/git-flow.mdc`).
- Do not merge to `main` or push a release tag without explicit operator approval in the current conversation.

## Language

English only for all project artifacts.
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Changed

- Branch policy matches pgwd / gghstats: topic branch → PR into `develop`; no direct push to `develop` or `main`. After `develop` → `main`, sync `main` into `develop` so the next release PR is not out-of-date.

### Security

- **Dependencies:** bump `google.golang.org/grpc` to **v1.83.2** (Dependabot [#7](https://github.com/hrodrig/groot/pull/7) / gRPC 1.83.x security fixes; transitive via GCS client — groot does not expose a gRPC server) and `golang.org/x/crypto` to **v0.56.0** (**GO-2026-6354** / **GO-2026-6355** — DoS in `crypto/ssh`; used by SFTP upload).
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Thanks for helping improve GROOT.
## How to contribute

- **Bugs and ideas:** Open an [issue](https://github.com/hrodrig/groot/issues). Describe what you expected, what happened, and how to reproduce (commands, config snippets, cluster context if relevant).
- **Code:** Open a pull request **against `develop`**. `main` is release-only; day-to-day work merges into `develop` first (see project git flow).

Use focused branches, for example `fix/short-topic` or `feat/short-topic`.
- **Code:** From an up-to-date `develop`, create a **topic branch** (`feat/…`, `fix/…`, `chore/…`, `security/…`, `docs/…`), push it, and open a pull request **into `develop`**. Wait for green CI, then merge.
- **Branch policy:** `develop` is integration; `main` is stable releases. **No direct push** to `develop` or `main` (GitHub rulesets `protect-develop` / `protect-main` — same pattern as [pgwd](https://github.com/hrodrig/pgwd) / [gghstats](https://github.com/hrodrig/gghstats)).
- **Release:** PR **`develop` → `main`**, then annotated tag `vX.Y.Z` on `main`. After every merge into `main`, sync **`main` → `develop`** so the next release PR is not **"out-of-date with the base branch"**.

## Planning docs (SPEC, ROADMAP, CHANGELOG)

Expand Down
Loading