docs(pypi): backlink to PyPI from README, docs, CHANGELOG, and future releases#27
Merged
Conversation
… releases - README badge row gains a PyPI version badge; install section text-links the package name to /project/yarlpattern/. Same in docs/index.md (a cross-domain backlink: chad-loder.github.io → pypi.org). - CHANGELOG header points at /project/yarlpattern/#history. - Custom PSR Jinja template under .semantic-release/templates/ emits a versioned PyPI deep-link on every new release heading: `## vX.Y.Z (date) — [Release](…) · [PyPI](…)`. Uses PSR's built-in `create_release_url` / `create_pypi_url` filters so the same template works across HVCS backends. - Only file deviating from PSR's bundled conventional/md/ templates is .components/versioned_changes.md.j2; the other eight are vendored verbatim because PSR uses templates/ as a binary switch (no merge with defaults). The heading format keeps the `# vX.Y.Z ` substring that PSR's update-mode dedup check requires, so CI retries are idempotent (verified against real git history). - Update mode preserves existing 0.1.0/0.2.0 entries verbatim; only releases cut from now on use the new format. Old end-of-file PSR stamp marker replaced with `<!-- version list -->` near the top, matching the v10 default insertion flag.
github-actions
Bot
added
the
documentation
Open
4 tasks
chad-loder
pushed a commit
that referenced
this pull request
May 14, 2026
The rewrite dropped the package-name link to the PyPI project page that #27 had deliberately added; restore it on the facts line under the install command. https://claude.ai/code/session_013t5L37cKtEoFkY3toL2XV1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/index.mdtext-link the package name tohttps://pypi.org/project/yarlpattern/./project/yarlpattern/#history..semantic-release/templates/emits a versioned PyPI deep-link on every new release heading:## vX.Y.Z (date) — [Release](…) · [PyPI](…). Only.components/versioned_changes.md.j2deviates from PSR's bundledconventional/md/defaults; the rest are vendored verbatim because PSR uses the template directory as a binary switch (no merge with defaults).# vX.Y.Zsubstring PSR's update-mode dedup check requires, so CI retries are idempotent (verified against real git history).Test plan
rumdl check README.md docs/index.md CHANGELOG.md— cleansemantic-release --noop changelogconfirms the newtemplate_dir = ".semantic-release/templates"is picked up (PSR takes the user-template code path, not the bundled defaults)