Repository navigation
fix: mark the packages as a release candidate in the READMEs - #340
Conversation
|
@codex review |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 60a81b0c08
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| [](https://github.com/awesome-reveal/awesome-reveal/blob/next/LICENSE) | ||
|
|
||
| > **Preview:** This is a prerelease of version 1.0. The API can change before the stable release. Tell us what works and what does not in [GitHub Discussions](https://github.com/awesome-reveal/awesome-reveal/discussions). | ||
| > **Release candidate:** This is a release candidate of version 1.0. The API is frozen, so only fixes go in before the stable release. Tell us what works and what does not in [GitHub Discussions](https://github.com/awesome-reveal/awesome-reveal/discussions). |
There was a problem hiding this comment.
Once these packages move to rc.0, this statement conflicts with the repository-level README.md, whose line 11 still labels the same @awesome-reveal/* packages as a preview and says their API can change. Users landing on the repository and users reading a package README therefore receive opposite guarantees about API stability; update the root notice in this change as well.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
@chatgpt-codex-connector Valid. Fixed in e2db974: the root README now has the same release candidate note as the package READMEs.
There was a problem hiding this comment.
Confirmed—commit e2db974 resolves the review finding. The repository-level README now identifies the packages as release candidates, states that the API is frozen, and matches the package README guidance. README.mdL11 packages/astro/README.mdL8
No additional code changes were necessary, so no new commit or pull request was created.
Testing
- ✅
sed -n '11p' README.md - ✅
for f in packages/{astro,core,react,react-awesome-reveal,vue}/README.md; do printf '%s: ' "$f"; sed -n '8p' "$f"; done - ✅
git status --short(working tree clean)
|
@codex review |
|
Codex Review: Didn't find any major issues. Already looking forward to the next diff. Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Summary
This PR prepares the first release candidate:
1.0.0-rc.0for core and the adapters, and5.0.0-rc.0forreact-awesome-reveal.release-please-config.json:prerelease-typeisrc.0, so later fixes giverc.1,rc.2and so on.release-assets the first RC version of each package. A change ofprerelease-typealone gives1.0.0-next.13.fix:, so that the squash commit is a visible commit forreact-awesome-reveal. Without it,node-workspacebumps the compat package only as a dependency update, ignoresrelease-as, and gives5.0.0-next.13.A release-please dry run on this branch gives
rc.0for all five packages.After the release, remove
release-asin the next PR. Otherwise, each later release tries to setrc.0again.Checklist
nextbranch.!and aBREAKING CHANGE:footer.