Skip to content

docs: add release docs update workflow#196

Merged
rachaelrenk merged 4 commits into
mainfrom
rachael/release-docs-update-workflow
Jun 9, 2026
Merged

docs: add release docs update workflow#196
rachaelrenk merged 4 commits into
mainfrom
rachael/release-docs-update-workflow

Conversation

@rachaelrenk

@rachaelrenk rachaelrenk commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a receiver workflow for release docs automation. This is the docs-side entry point for the planned channel-versions to docs dispatch flow.

Changes

  • Adds .github/workflows/release-docs-update.yml with manual workflow_dispatch support.
  • Adds a future repository_dispatch event type: release-docs-update.
  • Invokes the merged warpdotdev/docs:release_updates skill through warpdotdev/oz-agent-action@v1.
  • Validates and allowlists trigger inputs before they are included in the agent prompt.
  • Keeps the automatic channel_versions.json trigger disabled until the manual workflow prototype succeeds.

Current status

  • PR skills: add release_updates automation for release docs updates #171 has merged, so the release_updates skill is available on main.
  • WARP_API_KEY is configured as a repo-level GitHub Actions secret for warpdotdev/docs.
  • This workflow will not run automatically after merge; it only enables manual workflow_dispatch and future repository_dispatch testing.

Validation

  • Ran git diff --check before commit.
  • Verified release_updates is present on origin/main after PR skills: add release_updates automation for release docs updates #171 merged.
  • Ran a changelog-only dry run successfully against live channel_versions.json; it reported 0 new entries and wrote no files.
  • Addressed review feedback by normalizing dispatch inputs before passing trigger context to the agent.

Next steps after merge

  • Run the manual workflow_dispatch prototype with:
    • channel_versions_ref: main
    • task_set: changelog
    • create_draft_pr: true
    • assign_oncall_reviewers: false
  • Use that run to validate whether the default GitHub/Oz integration permissions can create or update docs PRs, or whether an additional GitHub token or app credential is needed.
  • Only after the manual run succeeds, add the channel-versions sender workflow.

References

Co-Authored-By: Oz oz-agent@warp.dev

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label Jun 9, 2026
@vercel

vercel Bot commented Jun 9, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 9, 2026 8:12pm

Request Review

@rachaelrenk rachaelrenk marked this pull request as ready for review June 9, 2026 19:54
@oz-for-oss

oz-for-oss Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

@rachaelrenk

I'm starting a first review of this pull request.

You can view the conversation on Warp.

I completed the review and no human review was requested for this pull request.

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

@oz-for-oss oz-for-oss Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Overview

This PR adds a GitHub Actions workflow that can run the release_updates skill manually or from repository_dispatch to create release docs update PRs.

Concerns

  • The workflow interpolates unvalidated repository_dispatch payload values directly into the Oz prompt while granting the run repo write and PR permissions.

Security

  • A crafted dispatch payload can include newlines or instructions that prompt-inject the agent before it creates branches or PRs. Validate/allowlist payload fields before prompt construction, or serialize them as explicitly untrusted data.

Verdict

Found: 0 critical, 1 important, 0 suggestions

Request changes

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Comment thread .github/workflows/release-docs-update.yml Outdated
Co-Authored-By: Oz <oz-agent@warp.dev>
@rachaelrenk rachaelrenk merged commit d95fc58 into main Jun 9, 2026
8 checks passed
@rachaelrenk rachaelrenk deleted the rachael/release-docs-update-workflow branch June 9, 2026 21:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants