Skip to content

docs: comprehensive README with release workflow and CI explanation#211

Merged
gtrivedi88 merged 1 commit into
redhat-appstudio:mainfrom
gtrivedi88:docs/readme-release-workflow
May 13, 2026
Merged

docs: comprehensive README with release workflow and CI explanation#211
gtrivedi88 merged 1 commit into
redhat-appstudio:mainfrom
gtrivedi88:docs/readme-release-workflow

Conversation

@gtrivedi88

Copy link
Copy Markdown
Contributor

Summary

Rewrites docs/README.md to fully document the publishing workflow. Addresses questions like "does the build use docs from the release branch or from a tag?" and "how does the check job gate the build?"

What's new

  • Cutting a new release section — step-by-step: create branch, update display_version, no CI changes needed
  • How publishing works — detailed job-by-job explanation:
    • How check writes to $GITHUB_OUTPUT and build reads it via needs.check.outputs.is-latest
    • Explicitly states: docs are built from the release branch itself, no docs branch or tag involved
    • GitHub Pages configuration requirements (source, deployment branch rules)
  • Flow diagram updated to show the build source
  • Directory structure updated to include toolbar.hbs
  • Branch table expanded with more context

What's removed

  • Old "When a new release is cut" section (replaced by "Cutting a new release")
  • Vague "no configuration needed" statement (replaced with specific steps)

Test plan

  • README renders correctly on GitHub

🤖 Generated with Claude Code

Rewrite docs/README.md to fully document:
- Cutting a new release (display_version, auto-detection)
- How publishing works with detailed job-by-job explanation
- How the check job gates build/deploy via GITHUB_OUTPUT
- That docs are built from the release branch directly (no docs
  branch or tag)
- GitHub Pages configuration requirements

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@gtrivedi88 gtrivedi88 merged commit 1850189 into redhat-appstudio:main May 13, 2026
4 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