Skip to content

chore: prepare release readiness docs and workflows#8

Merged
anton62k merged 3 commits into
masterfrom
chore/release-readiness
May 22, 2026
Merged

chore: prepare release readiness docs and workflows#8
anton62k merged 3 commits into
masterfrom
chore/release-readiness

Conversation

@anton62k

@anton62k anton62k commented May 22, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • New Features

    • Added npm package publishing workflow triggered by version tags.
    • Added release train workflow for managing release transitions.
  • Documentation

    • Redesigned README with package overview, API guidance, and usage examples.
    • Restructured documentation by removing temporary implementation tracker and updating contribution guidelines.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 22, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@anton62k has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 10 minutes and 16 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ba4b8d33-b0f0-4868-bf70-dbf3677e2cce

📥 Commits

Reviewing files that changed from the base of the PR and between b32a3fd and 494d1f4.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (3)
  • .github/workflows/npm-publish.yml
  • README.md
  • package.json
📝 Walkthrough

Walkthrough

This PR closes the temporary implementation-steps tracking phase and establishes mature package infrastructure. It removes the docs/steps.md file that documented PRs 1–8, updates all documentation and agent skills to reference docs/release-train.md for release governance instead, adds two new GitHub Actions workflows for npm publishing and release-train coordination, and completely rewrites the main README to document the forms-core headless MobX-forms package API surface, features, and consumer usage instead of development status and bootstrap patterns.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: preparing documentation and workflows for release readiness, which is reflected throughout the changeset including new release-train workflow, updated release-train docs, and removal of temporary implementation tracking docs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/release-readiness

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

@anton62k

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented May 22, 2026

Copy link
Copy Markdown
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/npm-publish.yml:
- Around line 4-7: The current GitHub Actions trigger under on.push.tags uses
the broad glob 'v*' which matches non-release tags; update the workflow trigger
(the push/tags entry) to semver-style globs such as 'v*.*.*' and 'v*.*.*-*' so
only release and prerelease tags (e.g., v1.2.3 and v1.2.3-rc.1) will trigger the
npm publish job.

In `@README.md`:
- Around line 281-286: The README claim "Use Node.js 20.16 or newer" and
package.json's engines.node (>=20.16.0) aren't exercised by CI which currently
pins node-version: 24.11.1 in .github/workflows/ci.yml; either add a CI
matrix/parallel job that includes node-version: 20.16 (keeping the same steps
npm ci and npm run verify used in the existing job) to validate the declared
floor, or update README/package.json to reflect the actual tested version;
modify .github/workflows/ci.yml (the job that currently references node-version:
24.11.1) to include node-version: [20.16, 24.11.1] or add a separate job for
node 20.16 so the engines.node constraint is covered by CI.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3dc5c7c5-07c3-4487-90b0-8acb43a26d05

📥 Commits

Reviewing files that changed from the base of the PR and between 3dfb7bf and b32a3fd.

📒 Files selected for processing (15)
  • .agents/README.md
  • .agents/rules/read-review-contract.mdc
  • .agents/skills/forms-core-general-checks/SKILL.md
  • .agents/skills/forms-core-implementation-step/SKILL.md
  • .agents/skills/forms-core-self-review/SKILL.md
  • .github/workflows/npm-publish.yml
  • .github/workflows/release-train.yml
  • AGENTS.md
  • README.md
  • REVIEW.md
  • docs/README.md
  • docs/handoff/README.md
  • docs/pr-plan.md
  • docs/release-train.md
  • docs/steps.md
💤 Files with no reviewable changes (3)
  • .agents/skills/forms-core-implementation-step/SKILL.md
  • docs/steps.md
  • .agents/README.md

Comment thread .github/workflows/npm-publish.yml
Comment thread README.md Outdated
@sonarqubecloud

Copy link
Copy Markdown

@anton62k anton62k merged commit 957fd28 into master May 22, 2026
3 checks passed
@anton62k anton62k deleted the chore/release-readiness branch May 22, 2026 08:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant