docs: add release publishing documentation to README

[petercrocker]

Document the three methods for publishing releases to PyPI:

• Automated release via PR labels and GitHub Release publishing
• Manual GitHub Release creation
• Manual workflow dispatch for emergency releases

Include PR labeling guide, troubleshooting section, and workflow reference.

Publish new bugfix release to resolve INFRAHUB_TLS_INSECURE issue in #104

Summary by CodeRabbit

• Documentation
  • Expanded README with a comprehensive "Publishing a Release" guide describing three release approaches (Automated Release, Manual GitHub Release, Manual Workflow Dispatch), prerequisites, step‑by‑step workflows, PR labeling guidance, version update steps, release notes generation, troubleshooting, and references to related workflows.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

README.md was expanded with a new "Publishing a Release" section documenting three release approaches: Automated Release, Manual GitHub Release, and Manual Workflow Dispatch. The section lists prerequisites, step-by-step workflows for each approach, PR labeling guidance, version update steps, release notes generation, troubleshooting tips, and references to related GitHub workflows. No code or logic changes were made.

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: add release publishing documentation to README' clearly and directly describes the main change: adding documentation about release publishing to the README file.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f98f34f and 7aebf75.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[uncategorized] ~53-~53: The official name of this software platform is spelled with a capital “H”.
Context: ... Auto-labeling rules are configured in .github/release-drafter.yml but require a sepa...

(GITHUB)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Cloudflare Pages

🔇 Additional comments (2)

README.md (2)

19-198: Comprehensive release documentation well-structured; workflow descriptions now accurate.

The new "Publishing a Release" section effectively documents three release approaches with clear prerequisites, step-by-step instructions, and practical troubleshooting guidance. The PR labeling guide and verification steps are particularly helpful. The workflow reference table (lines 191–198) now correctly reflects the invocation chain and workflow types—addressing the previous review feedback about workflow-release-drafter.yml and workflow-publish.yml descriptions.

---

53-53: LanguageTool flag: Directory path vs. brand name capitalization (false positive).

Static analysis flagged line 53's .github/release-drafter.yml as needing "GitHub" capitalization. This is a false positive—.github is the correct filesystem directory name (lowercase), distinct from "GitHub" the brand. No change needed.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

README.md (2)

53-57: Clarify auto-labeling rules implementation status.

The documentation describes auto-labeling rules based on PR title patterns, but it's unclear whether these rules are currently implemented in the repository or if they're aspirational. Consider adding a note about whether these are active features or planned enhancements.

---

65-65: Clarify that poetry.lock is updated automatically.

Line 65 lists "Update poetry.lock" as a step performed by the automation. However, poetry lock is typically run automatically when poetry version is executed. Consider clarifying that this file is updated as part of the automation rather than as a separate manual step, to avoid confusion in the context of the earlier "Method 1" instructions.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b39462e and f98f34f.

📒 Files selected for processing (1)

• README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Cloudflare Pages

🔇 Additional comments (2)

README.md (2)

19-22: Well-structured documentation section added.

The "Publishing a Release" section provides comprehensive coverage of three release approaches with clear prerequisites, step-by-step instructions, and verification guidance. The documentation is well-organized and should be helpful for contributors.

---

119-122: Clarify the runs-on workflow input.

Line 122 describes runs-on as a configurable input field in the GitHub UI for workflow dispatch. However, runs-on is typically a workflow-level configuration, not a user input parameter. Please verify that this field is actually exposed as a workflow input, or clarify the correct workflow inputs users should expect to see.

[cloudflare-workers-and-pages]

Deploying infrahub-sync with    Cloudflare Pages

Latest commit:	7aebf75
Status:	✅  Deploy successful!
Preview URL:	https://9f6cb837.infrahub-sync.pages.dev
Branch Preview URL:	https://pmc-20251220-release.infrahub-sync.pages.dev

View logs