feat: add release workflow, --version flag, and $RSHELL_VERSION by julesmcrt · Pull Request #183 · DataDog/rshell

julesmcrt · 2026-04-14T16:38:05Z

Summary

Adds internal/version package that reads the version from Go's embedded build info via runtime/debug — no hardcoded constant to maintain
Adds --version flag to the CLI (rshell --version)
Exposes $RSHELL_VERSION shell variable (like $BASH_VERSION in bash)
Adds an automated patch release workflow

⚠️ New release process

This PR adds a GitHub Actions workflow that fully automates patch releases. After merging, releasing a new version of rshell is:

Go to Actions > Release > Run workflow
Click Run workflow

That's it — no version number to type, no bump type to choose. The workflow automatically:

Finds the latest tag (e.g. v0.0.10)
Bumps the patch version (e.g. v0.0.11)
Tags the commit
Creates the GitHub release with auto-generated changelog

No commits to main — the workflow only creates a tag and release.

Access control

The workflow uses a GitHub environment (release) that requires approval from designated reviewers. Anyone with write access can trigger it, but it won't execute until someone on the reviewer list approves it.

Setup required after merging: Go to Settings > Environments > New environment > name it release > check "Required reviewers" > add the people who can approve releases.

Version in builds

Build method	Version source
Datadog Agent (library import)	`runtime/debug` reads version from `go.mod` deps
`go install ...@v0.0.11`	`runtime/debug` reads main module version
`make build` / `go build` (standalone)	`dev` (standalone usage is not a supported use case)

$RSHELL_VERSION

Scripts can access the version via $RSHELL_VERSION, similar to $BASH_VERSION:

echo $RSHELL_VERSION

Test plan

rshell --version works
$RSHELL_VERSION is set in the interpreter environment
runtime/debug correctly reads version from dependency info (e2e test with published v0.0.10)
Full test suite passes (go test ./...)

🤖 Generated with Claude Code

Add internal/version package with a source constant as single source of truth for the release version, overridable via ldflags for dev builds. Update the Makefile to inject version + commit at build time via git describe. Add a GitHub Actions release workflow (workflow_dispatch) that auto-computes the next version from the latest git tag. Pick patch/minor/major from a dropdown and click Run — no version to type. The workflow bumps the constant, commits, tags, and creates the release. Access is gated by a "release" environment requiring reviewer approval. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Remove the major/minor/patch dropdown from the release workflow — it now always bumps the patch version, reducing room for human error. Add `--version` flag to the CLI via cobra's built-in Version field. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Replace the hardcoded version constant with debug.ReadBuildInfo() to read the version from Go's embedded dependency info. When rshell is imported as a library (e.g. by the Datadog Agent), this automatically picks up the version from go.mod — no source constant to maintain. This also simplifies the release workflow: it no longer needs to sed the version file and commit before tagging. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

rshell is only used as a library via the agent, so the ldflags version override for standalone dev builds adds complexity for no benefit. Remove VERSION/COMMIT/LDFLAGS from the Makefile and the Commit variable from the version package. ldflags can still be used if needed. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Use testdata/depcheck/ — a small Go program that imports rshell as a dependency and prints the version from debug.ReadBuildInfo(). The test copies it to a temp dir with a replace directive pointing to local rshell, builds and runs it, and verifies it finds a version in the deps list. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Use a realistic version (v1.2.3) instead of v0.0.0, and assert the exact value instead of just checking it's non-empty. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add missing copyright header to testdata/depcheck/main.go (compliance check failure). Move ldflags note to buildVersion doc comment to reduce redundancy. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

matt-dz · 2026-04-15T16:12:49Z

would be nice to have a scenario test that tests rshell --version. the output would be something like rshell version v0.0.11-0.20260415155454-850201aab166 and you can have an stdout_contains field with rshell version.

julesmcrt · 2026-04-16T09:33:52Z

#183 (comment)

would be nice to have a scenario test that tests rshell --version. the output would be something like rshell version v0.0.11-0.20260415155454-850201aab166 and you can have an stdout_contains field with rshell version.

Since in tests rshell is the main module, running rshell --version will output dev
I still added a test, with a comment explaining that

- Set $RSHELL_VERSION in the interpreter environment (like $BASH_VERSION) - Add TestVersion for rshell --version CLI output - Simplify depcheck e2e test: use published v0.0.10 with a plain go.mod instead of runtime replace directive patching - Add scenario test for $RSHELL_VERSION Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

julesmcrt · 2026-04-16T09:57:59Z

Added TestVersion in cmd/rshell/main_test.go — asserts rshell --version outputs rshell version dev\n (standalone builds return "dev" since rshell is the main module; see comment on the test for details).

Also added a scenario test tests/scenarios/shell/environment/rshell_version_is_set.yaml that tests $RSHELL_VERSION — a new shell variable exposed like $BASH_VERSION in bash (per Alex's suggestion).

CombinedOutput() captures stderr too, so "go: downloading ..." progress lines from `go run` polluted stdout on CI (where the module isn't cached). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

julesmcrt mentioned this pull request Apr 14, 2026

feat(help): show version, command counts, and allowed/disabled builtins #181

Merged

5 tasks

julesmcrt marked this pull request as ready for review April 14, 2026 16:41

julesmcrt requested review from AlexandreYang, astuyve, matt-dz, thieman and val06 as code owners April 14, 2026 16:41

matt-dz requested changes Apr 14, 2026

View reviewed changes

Comment thread internal/version/version.go

matt-dz reviewed Apr 14, 2026

View reviewed changes

Comment thread Makefile Outdated

matt-dz reviewed Apr 14, 2026

View reviewed changes

Comment thread .github/workflows/release.yml

julesmcrt and others added 3 commits April 15, 2026 17:04

julesmcrt changed the title ~~feat: add version package and automated release workflow~~ feat: add automated release workflow and --version flag Apr 15, 2026

matt-dz reviewed Apr 15, 2026

View reviewed changes

Comment thread cmd/rshell/main.go

matt-dz reviewed Apr 15, 2026

View reviewed changes

Comment thread internal/version/version_test.go

matt-dz requested changes Apr 15, 2026

View reviewed changes

julesmcrt and others added 3 commits April 15, 2026 17:40

improve version e2e test: use v1.2.3 and assert exact match

16d2e13

Use a realistic version (v1.2.3) instead of v0.0.0, and assert the exact value instead of just checking it's non-empty. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

fix: add copyright header and clean up version.go comments

850201a

Add missing copyright header to testdata/depcheck/main.go (compliance check failure). Move ldflags note to buildVersion doc comment to reduce redundancy. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

matt-dz approved these changes Apr 15, 2026

View reviewed changes

AlexandreYang approved these changes Apr 15, 2026

View reviewed changes

AlexandreYang reviewed Apr 15, 2026

View reviewed changes

Comment thread internal/version/testdata/depcheck/go.mod.test Outdated

julesmcrt changed the title ~~feat: add automated release workflow and --version flag~~ feat: add release workflow, --version flag, and $RSHELL_VERSION Apr 16, 2026

fix: use Output() instead of CombinedOutput() in depcheck test

137f50c

CombinedOutput() captures stderr too, so "go: downloading ..." progress lines from `go run` polluted stdout on CI (where the module isn't cached). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

julesmcrt added this pull request to the merge queue Apr 16, 2026

Merged via the queue into main with commit cc19048 Apr 16, 2026
34 checks passed

julesmcrt deleted the jules.macret/Q/release-workflow branch April 16, 2026 11:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add release workflow, --version flag, and $RSHELL_VERSION#183

feat: add release workflow, --version flag, and $RSHELL_VERSION#183
julesmcrt merged 9 commits intomainfrom
jules.macret/Q/release-workflow

julesmcrt commented Apr 14, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matt-dz commented Apr 15, 2026

Uh oh!

Uh oh!

julesmcrt commented Apr 16, 2026

Uh oh!

julesmcrt commented Apr 16, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

julesmcrt commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

⚠️ New release process

Access control

Version in builds

$RSHELL_VERSION

Test plan

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matt-dz commented Apr 15, 2026

Uh oh!

Uh oh!

julesmcrt commented Apr 16, 2026

Uh oh!

julesmcrt commented Apr 16, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

julesmcrt commented Apr 14, 2026 •

edited

Loading