Skip to content

docs: refer to semantic-release instead of release-please#1097

Merged
frankieyan merged 3 commits into
mainfrom
frankie/remove-release-please-reference
Jul 16, 2026
Merged

docs: refer to semantic-release instead of release-please#1097
frankieyan merged 3 commits into
mainfrom
frankie/remove-release-please-reference

Conversation

@frankieyan

Copy link
Copy Markdown
Member

Short description

Updates various docs to remove references to release-please, as we've already moved onto semantic-release in #1024.

PR Checklist

  • Updated docs (storybooks, readme)

Co-Authored-By: Claude <noreply@anthropic.com>

@doistbot doistbot left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This PR swaps out release-please references for semantic-release across the docs, README, and PR template to reflect the move made in #1024.

I also included a few optional follow-up notes in the details below.

Optional follow-up notes (3)
  • P3 README.md:230: The new sentence lists feat:, fix:, feat!: and fix!: as releasing commits but omits perf:. With the conventionalcommits preset used in release.config.js, perf: also triggers a patch release. Consider adding it to the list (e.g., feat:, fix:, perf:, and their ! variants) to match the actual semantic-release behavior.
  • P3 AGENTS.md:117: This blank line (and the one added at L224) sits inside the <!-- shared-config:agents --> ... <!-- /shared-config:agents --> region. Per the file's own header, everything below the shared-config:agents marker is synced from Doist/shared-configs and must not be edited directly — these additions will be overwritten on the next sync. If the spacing is desired, it should be added upstream in shared-configs instead.
  • P3 README.md:228: This bullet is under the "semantic-release:" header, but semantic-release only publishes to npm (the npx semantic-release step). The GitHub Packages publish is a separate npm publish step later in publish-package-release.yml. As written, it attributes both registries to semantic-release, which would mislead anyone debugging a GitHub Packages publish failure toward the wrong step. Either drop "and GitHub Packages" here or call out the separate publish step.

Share FeedbackReview Logs

Comment thread AGENTS.md
- PR titles must follow [conventional commits](https://www.conventionalcommits.org/): `feat:`, `fix:`, `chore:`, `refactor:`, `test:`, `docs:`, etc.
- `feat:` triggers a minor version bump, `fix:` triggers a patch, `feat!:` or `fix!:` triggers a major (breaking)
- Versioning is automated by release-please based on PR title
- Versioning is automated by semantic-release based on PR title

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

P2 semantic-release's configured commit analyzer reads Git commit messages, not GitHub PR metadata. PR titles can differ from the resulting commits (for example with rebase merges), so describe versioning in terms of conventional commit messages and align the README guidance with that source of truth.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@doistbot we squash commits in this repo with the commit message defaulting to the PR title. Rarely will the final message deviate so I think this should be clear enough.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

That makes “PR title” a practical shorthand for this repository, since squash merges normally carry it into the resulting commit. However, semantic-release itself doesn’t read GitHub PR metadata: release.config.js uses @semantic-release/commit-analyzer, which analyzes commit messages on main.

I’d keep the wording technically precise and mention the workflow explicitly:

Versioning is automated by semantic-release based on conventional commit messages. With squash merges, the resulting commit message normally defaults to the PR title.

That preserves the current practice without implying the PR title is semantic-release’s source of truth.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

You are technically right, but I'm gonna overrule this and say this is ok 😎 (let's see if your human colleague disagrees)

@frankieyan frankieyan added the 👀 Show PR Used for PRs that need a review, but can be merged when CI is green. label Jul 16, 2026
@frankieyan frankieyan force-pushed the frankie/remove-release-please-reference branch from 35f89c1 to 089bc6d Compare July 16, 2026 04:09
frankieyan and others added 2 commits July 15, 2026 21:11
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
@frankieyan frankieyan force-pushed the frankie/remove-release-please-reference branch from 089bc6d to 43b928f Compare July 16, 2026 04:11
@frankieyan frankieyan requested review from a team and engfragui and removed request for a team July 16, 2026 04:39
@frankieyan frankieyan merged commit a351c59 into main Jul 16, 2026
10 checks passed
@frankieyan frankieyan deleted the frankie/remove-release-please-reference branch July 16, 2026 04:40
@doist-release-bot

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 34.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@doist-release-bot doist-release-bot Bot added the Released PRs that have been merged and released label Jul 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Released PRs that have been merged and released 👀 Show PR Used for PRs that need a review, but can be merged when CI is green.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants