Skip to content

chore: release prep — repo move, docs, coderabbit#81

Merged
robbycochran merged 11 commits into
mainfrom
rc-release-prep
Jun 17, 2026
Merged

chore: release prep — repo move, docs, coderabbit#81
robbycochran merged 11 commits into
mainfrom
rc-release-prep

Conversation

@robbycochran

@robbycochran robbycochran commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

Summary

Release prep for the move to stackrox/harness-openshell.

  • Module path: github.com/robbycochran/harness-openshellgithub.com/stackrox/harness-openshell (go.mod, all imports, README, release docs)
  • Env vars: simplify ${JIRA_URL} to empty-value shorthand across all configs
  • README: coding agent as first use case, real default config in YAML examples, openshell term for policy management, future work section, typo fixes
  • CodeRabbit: review config with Go-specific and profile-specific instructions
  • .coderabbit.yaml: chill profile, path-specific review instructions for Go code, YAML profiles, and test scripts

Test plan

  • make test — 5/5 packages pass (new module path)
  • make test-suite — 23/23 pass
  • go build ./... — compiles clean

Summary by CodeRabbit

  • Documentation

    • Refreshed README with a clearer “Coding agent” quick-start, improved deployment examples, consolidated guidance for retrieving task output, and expanded runtime/policy inspection instructions.
    • Updated release plan installation command to fetch artifacts from the new repo location.
  • Configuration

    • Updated Atlassian/Jira-related profile and spec examples to avoid ${...} interpolation, using empty/pass-through values that are sourced from the host environment instead.
  • Chores

    • Added repository-wide CodeRabbit configuration and updated the Go module namespace accordingly.

Replace ${JIRA_URL} with empty value — both read from host env,
but the empty form is cleaner. The ${VAR} syntax is still supported
for composition (e.g., JIRA_URL: https://${DOMAIN}).
Updated README to clarify harness usage and OpenShell description.
Show the actual default config with all four providers and payloads.
Multi-doc example uses base_agent, repo, inline CLAUDE.md, and L7
policy with git clone/push rules. Note harness apply -o yaml for
the full resolved output.
Update go.mod module path, all import statements, README download
URL, and release docs to reflect the new repo location under stackrox.
@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 0c41f475-bfe4-4122-acc2-97168fcdcd9d

📥 Commits

Reviewing files that changed from the base of the PR and between edbd596 and 64aa9dc.

📒 Files selected for processing (2)
  • .coderabbit.yaml
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

Walkthrough

Renames the Go module from github.com/robbycochran/harness-openshell to github.com/stackrox/harness-openshell, updating all import paths across go.mod, main.go, cmd/, and internal/ packages. Simultaneously changes Atlassian provider JIRA_URL/JIRA_USERNAME env entries from ${VAR} interpolation to empty values in all profiles, test configs, and spec docs. Also adds .coderabbit.yaml and refreshes README.md with Coding agent examples, result-extraction guidance, expanded runtime/policy docs, and future work items.

Changes

Go module rename to stackrox

Layer / File(s) Summary
go.mod declaration and main.go entry point
go.mod, main.go
Module path updated from robbycochran to stackrox; main.go import paths follow.
Internal package import updates (gateway, k8s)
internal/gateway/cli.go, internal/k8s/kubectl.go
Cross-package status imports updated to new module path.
cmd/ source file imports
cmd/apply.go, cmd/delete.go, cmd/deploy.go, cmd/describe.go, cmd/doctor.go, cmd/executor.go, cmd/get.go, cmd/init_cmd.go, cmd/providers.go, cmd/resolve.go, cmd/sandbox.go, cmd/status_cmd.go, cmd/teardown.go
All production command files update internal agent, gateway, k8s, and status imports.
cmd/ test file imports
cmd/deploy_test.go, cmd/doctor_test.go, cmd/executor_test.go, cmd/helpers_test.go, cmd/init_cmd_test.go, cmd/providers_test.go, cmd/status_cmd_test.go, cmd/teardown_test.go
All test files update their internal package imports to the stackrox module namespace.
Release-plan doc URL
docs/release-plan.md
gh release download --repo value updated to stackrox/harness-openshell.

Atlassian env var format: empty-value passthrough

Layer / File(s) Summary
Spec and profiles README
SPEC.md, profiles/README.md
providers[].env examples updated from ${JIRA_URL}/${JIRA_USERNAME} interpolation to empty values; README notes they are read from the host environment when empty.
Agent profile YAMLs
profiles/agent-default.yaml, profiles/agent-ocp.yaml, profiles/agent-opencode.yaml
JIRA_URL and JIRA_USERNAME entries changed to bare keys without values in all three profiles.
Integration test config YAMLs
test/configs/agent-atlassian.yaml, test/configs/agent-all-providers.yaml, test/configs/agent-multi-provider.yaml
Same env var format change applied to all Atlassian-related test configs.

CodeRabbit config and README refresh

Layer / File(s) Summary
CodeRabbit configuration
.coderabbit.yaml
New file sets language to en-US, enables review status and summaries, disables request-changes and poem output, configures knowledge-base scopes, and defines targeted path_instructions for Go files, profile YAMLs, spec/docs, sandbox assets, integration tests, and CI workflows.
README quick-start and runtime docs
README.md
Adds Coding agent attach examples for Podman/OpenShift/OpenCode; clarifies repo cloning outside sandbox and base_agent inheritance; consolidates result extraction via --task, openshell sandbox exec, and github provider; expands openshell runtime commands (connect/exec/logs) and policy inspection (openshell policy get, openshell term); introduces Future Work section covering CI automation, observability, skills, plugins, and Linux validation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'chore: release prep — repo move, docs, coderabbit' accurately captures the main changes: module path migration to stackrox, documentation updates, and CodeRabbit configuration addition.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch rc-release-prep

Comment @coderabbitai help to get the list of available commands and usage tips.

@robbycochran robbycochran changed the title chore: release prep — simplify env vars chore: release prep — repo move, docs, coderabbit Jun 17, 2026
Add architecture context, file-specific review instructions for
SPEC.md, AGENTS.md, agent configs, provider profiles, gateway
profiles, sandbox image files, and CI workflows. Enable knowledge
base with auto-scoped learnings.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 49: In the README.md documentation, locate the text describing the
provider functionality where it mentions "attach a `github` provider so the
agent can push directly via the scoped proxy token". Replace the lowercase
`github` with the properly capitalized `GitHub` to match official product naming
conventions and maintain consistent professional documentation standards.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 74f06cab-7409-4aaa-a761-2b245b46c25a

📥 Commits

Reviewing files that changed from the base of the PR and between d1fe1a3 and edbd596.

📒 Files selected for processing (36)
  • .coderabbit.yaml
  • README.md
  • SPEC.md
  • cmd/apply.go
  • cmd/delete.go
  • cmd/deploy.go
  • cmd/deploy_test.go
  • cmd/describe.go
  • cmd/doctor.go
  • cmd/doctor_test.go
  • cmd/executor.go
  • cmd/executor_test.go
  • cmd/get.go
  • cmd/helpers_test.go
  • cmd/init_cmd.go
  • cmd/init_cmd_test.go
  • cmd/providers.go
  • cmd/providers_test.go
  • cmd/resolve.go
  • cmd/sandbox.go
  • cmd/status_cmd.go
  • cmd/status_cmd_test.go
  • cmd/teardown.go
  • cmd/teardown_test.go
  • docs/release-plan.md
  • go.mod
  • internal/gateway/cli.go
  • internal/k8s/kubectl.go
  • main.go
  • profiles/README.md
  • profiles/agent-default.yaml
  • profiles/agent-ocp.yaml
  • profiles/agent-opencode.yaml
  • test/configs/agent-all-providers.yaml
  • test/configs/agent-atlassian.yaml
  • test/configs/agent-multi-provider.yaml

Comment thread README.md
@robbycochran robbycochran merged commit e7742cc into main Jun 17, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant