Skip to content

Bundle worker runtime output release#139

Merged
fqjony merged 17 commits into
latestfrom
single-release-20260617
Jun 18, 2026
Merged

Bundle worker runtime output release#139
fqjony merged 17 commits into
latestfrom
single-release-20260617

Conversation

@fqjony

@fqjony fqjony commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Summary

Bundles the open worker update PRs into one release branch so latest gets a single coordinated release workflow run.

Release Scope

Integration Adjustments

  • Resolve Dockerfile dependency conflicts with the current available package pins:
    • nano=8.4-1ubuntu0.1
    • vim=2:9.1.0967-1ubuntu6.6
  • Align runtime output artifact upload with actions/upload-artifact@v7.
  • Rename the Docker Ops workflow to Build/Release for clearer release ownership.
  • Add a separate Runtime Output CI job that:
    • builds the worker image locally,
    • captures docker run ... true > runtime-output/runtime.json,
    • validates the JSON contract with jq,
    • uploads the runtime JSON artifact.
  • Move the runtime output contract into docs/runtime-output.md and leave docs/config.md focused on worker config.

Runtime Output Contract

  • Public env:
    • WORKER_RUNTIME_OUTPUT=false by default
    • WORKER_RUNTIME_OUTPUT=true emits the runtime contract JSON
  • Output shape:
    • env: resolved non-secret environment variables
    • redacted: env names omitted because they are configured as secrets or secret references
    • paths: worker config, services config, and generated environment file paths
  • Capture examples:
    • normal runtime with processes: docker run -e WORKER_RUNTIME_OUTPUT=true image > runtime-output/runtime.json
    • contract-only workflow capture: docker run --rm -e WORKER_RUNTIME_OUTPUT=true image true > runtime-output/runtime.json

Validation

  • Local validation:
    • bash -n lib/runtime_output.sh
    • bash -n test/modules/25_runtime_output.sh
    • yq eval . .github/workflows/docker-ops.yml
    • yq eval . .github/workflows/docker-dependency-updater.yml
    • git diff --check origin/latest..HEAD
    • make build
    • make test
    • runtime capture JSON validated with jq
  • GitHub checks:
    • CodeQL passed
    • action, shell, Dockerfile, and YAML analysis passed
    • Runtime Output job passed on the runtime workflow commit

Review Notes

  • This PR is prepared for review only; it has not been merged.
  • Copilot review threads have been handled and resolved.

fqjony and others added 8 commits June 5, 2026 16:12
Bumps [actions/github-script](https://github.com/actions/github-script) from 8 to 9.
- [Release notes](https://github.com/actions/github-script/releases)
- [Commits](actions/github-script@v8...v9)

---
updated-dependencies:
- dependency-name: actions/github-script
  dependency-version: '9'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 5 to 7.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](actions/upload-artifact@v5...v7)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Bumps [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) from 7.0.11 to 8.1.1.
- [Release notes](https://github.com/peter-evans/create-pull-request/releases)
- [Commits](peter-evans/create-pull-request@22a9089...5f6978f)

---
updated-dependencies:
- dependency-name: peter-evans/create-pull-request
  dependency-version: 8.1.1
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
…rigin/dependabot/github_actions/dot-github/workflows/actions/github-script-9', 'origin/dependabot/github_actions/dot-github/workflows/actions/upload-artifact-7', 'origin/dependabot/github_actions/dot-github/workflows/peter-evans/create-pull-request-8.1.1' and 'origin/cleanup-worker-runtime-docs' into single-release-20260617

# Conflicts:
#	Dockerfile
Copilot AI review requested due to automatic review settings June 17, 2026 11:01

Copilot AI 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.

Pull request overview

Bundles multiple pending worker changes into a single merge to trigger one release workflow run, including the new “runtime output” artifact/log emission intended for workflow/deployment integrations.

Changes:

  • Adds runtime output generation that emits resolved non-secret env values plus a redacted name list, with optional structured log output (WORKER_OUTPUT_LOG).
  • Extends CI to build the PR SHA image, capture runtime output JSON, write it to the step summary, and upload it as an artifact.
  • Updates Dockerfile pins/installer steps and bumps several GitHub Actions workflow dependencies.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
lib/runtime_output.sh Reworks runtime-output JSON to emit non-secret env values + a redacted list, and adds optional structured log emission.
test/modules/25_runtime_output.sh Adds a test module validating runtime output redaction behavior and log-line formatting.
src/configs/worker.yaml Introduces WORKER_OUTPUT_LOG default setting in built-in config.
docs/config.md Documents WORKER_OUTPUT_FILE and the new WORKER_OUTPUT_LOG behavior and output fields.
Dockerfile Updates package pins and hardens cleanup/timezone/yq installation steps.
.github/workflows/docker-ops.yml Adds a “Runtime Output” job to capture/upload runtime output from a locally-built image.
.github/workflows/docker-dependency-updater.yml Bumps actions/github-script and actions/upload-artifact versions and updates create-pull-request pin.
.rabbit/context.yaml Updates generator timestamp metadata.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread lib/runtime_output.sh
Comment thread test/modules/25_runtime_output.sh
Comment thread docs/config.md Outdated
Copilot AI review requested due to automatic review settings June 17, 2026 11:16

Copilot AI 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.

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Comment thread lib/env_handler.sh
Copilot AI review requested due to automatic review settings June 17, 2026 12:29

Copilot AI 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.

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.

Comment thread lib/runtime_output.sh
Comment thread Makefile.help Outdated
@fqjony fqjony self-assigned this Jun 17, 2026
@fqjony fqjony added documentation Improvements or additions to documentation enhancement New feature or request github_actions Pull requests that update GitHub Actions code docker Pull requests that update docker code labels Jun 17, 2026
Copilot AI review requested due to automatic review settings June 17, 2026 13:56

Copilot AI 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.

Pull request overview

Copilot reviewed 12 out of 13 changed files in this pull request and generated no new comments.

Copilot AI review requested due to automatic review settings June 18, 2026 09:36
@fqjony fqjony requested a review from a team June 18, 2026 09:39

Copilot AI 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.

Pull request overview

Copilot reviewed 16 out of 17 changed files in this pull request and generated no new comments.

@fqjony fqjony enabled auto-merge June 18, 2026 09:49
@fqjony fqjony merged commit 3b85801 into latest Jun 18, 2026
8 checks passed
@fqjony fqjony deleted the single-release-20260617 branch June 18, 2026 09:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docker Pull requests that update docker code documentation Improvements or additions to documentation enhancement New feature or request github_actions Pull requests that update GitHub Actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants