Update docs and release automation by RareBird15 · Pull Request #4 · RareBird15/bible-reader

RareBird15 · 2026-04-10T01:27:19Z

Update documentation and improve release automation for the Bible Reader project.

What Changed

Enhanced the GitHub Actions workflow for creating releases and publishing to PyPI.
Updated installation instructions in the README to clarify usage of uv and pip.
Added a section for requesting support.

Why

Streamlined the release process and ensured users have clear installation guidance.

Validation

uvx ruff check .
uv run python -m unittest discover tests -v
I tested the affected workflow manually, if applicable

Accessibility Review

I considered how this change sounds in a screen reader, not just how it looks in a terminal
I did not add decorative ASCII, visual-only cues, or formatting that makes output harder to read aloud
Prompts, labels, and headings remain plain, predictable, and understandable

Content and Policy Review

I did not commit copyrighted EPUBs or generated plan content without explicit rights
I updated documentation if user-visible behavior changed
I updated CHANGELOG.md if this change is user-visible

Notes for Reviewers

Review the changes in the release workflow and ensure the installation instructions are clear for users.

Copilot

Pull request overview

This PR updates end-user documentation and expands the GitHub Actions release workflow so that version tag pushes create a GitHub Release and also publish the package to PyPI.

Changes:

Refreshes README installation guidance for uv vs pip, and adds a “Request Support” section.
Enhances the release workflow to generate release notes from CHANGELOG.md and publish artifacts to both GitHub Releases and PyPI.
Improves README formatting (badges and heading punctuation).

Reviewed changes

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

File	Description
README.md	Updates badges, simplifies installation instructions, tweaks quick-start wording, and adds a support-request section.
.github/workflows/release.yml	Re-indents/cleans the workflow and adds a new `publish-pypi` job using Trusted Publishing (OIDC).

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

Copilot · 2026-04-10T01:30:06Z

+          TAG_NAME: ${{ github.ref_name }}
+        run: |
+          set -eu
+          VERSION="${TAG_NAME#v}"


The shell variable VERSION is set but never used (the embedded Python reads TAG_NAME directly). Removing it avoids confusion and keeps the step minimal.

Suggested change

VERSION="${TAG_NAME#v}"

Copilot · 2026-04-10T01:30:06Z

+      - name: Install uv
+        uses: astral-sh/setup-uv@v5

-            - name: Build package distribution
-              run: uv build
+      - name: Build package distribution
+        run: uv build


The release workflow builds the package without pinning/installing a Python version (unlike CI, which runs uv python install ...). For reproducible builds and to avoid ubuntu-latest Python upgrades breaking releases, add an explicit Python install/select step (e.g., 3.11) before uv build in both jobs.

Copilot · 2026-04-10T01:30:06Z

+      - name: Build package distribution
+        run: uv build



Now that tags trigger an automated PyPI publish, add a guard that verifies the Git tag version matches the package version (e.g., from pyproject.toml). Without this, it’s possible to publish a different version than the tag/release notes indicate, leading to inconsistent GitHub Releases vs PyPI artifacts.

Copilot · 2026-04-10T01:30:07Z

+          if not changelog.exists():
+              out.write_text(
+                  f"Release {version}\n\nSee repository history for details.\n",
+                  encoding="utf-8",
+              )
+              raise SystemExit(0)

-                  text = changelog.read_text(encoding="utf-8")
+          text = changelog.read_text(encoding="utf-8")

-                  pattern = re.compile(
-                      rf"^## \[{re.escape(version)}\].*?$\n(.*?)(?=^## \[|\Z)",
-                      re.M | re.S,
-                  )
-                  match = pattern.search(text)
+          pattern = re.compile(
+              rf"^## \[{re.escape(version)}\].*?$\n(.*?)(?=^## \[|\Z)",
+              re.M | re.S,
+          )
+          match = pattern.search(text)

-                  if not match:
-                      out.write_text(
-                          (
-                              f"Release {version}\n\n"
-                              "No matching changelog section was found. "
-                              "Please update CHANGELOG.md.\n"
-                          ),
-                          encoding="utf-8",
-                      )
-                      raise SystemExit(0)
+          if not match:
+              out.write_text(
+                  (
+                      f"Release {version}\n\n"
+                      "No matching changelog section was found. "
+                      "Please update CHANGELOG.md.\n"
+                  ),
+                  encoding="utf-8",
+              )
+              raise SystemExit(0)



If CHANGELOG.md is missing or the tagged version section isn’t found, the workflow currently exits successfully and continues to create a GitHub Release (and will also publish to PyPI). Consider failing the job in these cases so releases aren’t published without a matching changelog entry.

Copilot · 2026-04-10T01:30:07Z

+### 1. One-Time Setup (From EPUB)

-If you are starting from a new WorldBiblePlans EPUB, run this sequence from the project root:
+If you are starting from a new WorldBiblePlans EPUB, create a folder for your plan and run this sequence:



The headings in this section are now inconsistent: ### 1. ... is unescaped, but the subsequent headings still use escaped dots (### 2\. / ### 3\.). For consistent Markdown (and screen reader output), use the same numbering style for all three headings.

RareBird15

@copilot Please do another review.

…ease workflow Agent-Logs-Url: https://github.com/RareBird15/bible-reader/sessions/14baaa63-0678-4c00-91d1-937c8c85819e Co-authored-by: RareBird15 <13343932+RareBird15@users.noreply.github.com>

Copilot · 2026-04-10T01:48:36Z

@copilot Please do another review.

Addressed all outstanding review feedback in commit 2ca8573:

Python version pin: Added uv python install 3.11 in create-release (matching the CI workflow pattern)
Tag/version guard: Added a step that reads the version from pyproject.toml and fails the job if it doesn't match the pushed tag
Single build: Package is now built once in create-release, uploaded via actions/upload-artifact@v4, and downloaded in publish-pypi via actions/download-artifact@v4 — eliminating the duplicate build

The previous commits already covered removing the unused VERSION variable, making CHANGELOG failures hard errors, and aligning the README heading dots.

Update docs and release automation

db2eb50

Copilot AI review requested due to automatic review settings April 10, 2026 01:27

Copilot started reviewing on behalf of RareBird15 April 10, 2026 01:27 View session

Copilot AI reviewed Apr 10, 2026

View reviewed changes

Fix merge conflicts in release workflow

a5ed917

RareBird15 assigned Copilot Apr 10, 2026

RareBird15 added documentation Improvements or additions to documentation github_actions Pull requests that update GitHub Actions code labels Apr 10, 2026

Polish docs and release logic

0aa30fe

RareBird15 commented Apr 10, 2026

View reviewed changes

Copilot started work on behalf of RareBird15 April 10, 2026 01:45 View session

Add Python pin, version guard, and single-build artifact reuse in rel…

2ca8573

…ease workflow Agent-Logs-Url: https://github.com/RareBird15/bible-reader/sessions/14baaa63-0678-4c00-91d1-937c8c85819e Co-authored-by: RareBird15 <13343932+RareBird15@users.noreply.github.com>

Copilot finished work on behalf of RareBird15 April 10, 2026 01:49

RareBird15 self-assigned this Apr 10, 2026

RareBird15 merged commit 3d5a3e3 into main Apr 10, 2026
4 checks passed

RareBird15 deleted the lanie/auto-publish-and-docs branch April 10, 2026 02:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update docs and release automation#4

Update docs and release automation#4
RareBird15 merged 4 commits into
mainfrom
lanie/auto-publish-and-docs

RareBird15 commented Apr 10, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 10, 2026

Uh oh!

Copilot AI Apr 10, 2026

Uh oh!

Copilot AI Apr 10, 2026

Uh oh!

Copilot AI Apr 10, 2026

Uh oh!

Copilot AI Apr 10, 2026

Uh oh!

Uh oh!

RareBird15 left a comment

Uh oh!

Copilot AI commented Apr 10, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

RareBird15 commented Apr 10, 2026

What Changed

Why

Validation

Accessibility Review

Content and Policy Review

Notes for Reviewers

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

RareBird15 left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Apr 10, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants