Refresh README badges and align branch guidance by oleg-koval · Pull Request #58 · oleg-koval/semantic-release-npm-github-publish

oleg-koval · 2026-04-04T15:09:06Z

Summary

Refresh the README badge block and remove stale master-branch guidance now that the repository has fully moved to main.

Problem

The README still described the master-to-main transition and the repo-only release config/workflows still referenced master even though the default branch is main and the remote master branch is gone.

Solution

Center the badge block, add a few high-signal badges, update the maintenance notes, and align the repo-only release policy and workflows to main plus beta.

Changes

center README badges and add CodeQL and npm downloads badges
update README maintenance notes to reflect main as the live default branch
remove master from repo-only release branches and workflow triggers
update the branch-policy test accordingly

Out of scope

None

Related issues

None

Validation

npm test
npm run docs:index:check

Screenshots / Demo

N/A

Risk and impact

Low; documentation and branch trigger cleanup only

Breaking changes

None

Documentation

README updated

Reviewer notes

This assumes the repository will continue using main for stable releases and beta for prereleases.

Summary by CodeRabbit

Chores
- Updated CI/CD and release automation workflows to operate exclusively on main and beta branches, removing legacy branch support.
- Updated release configuration to use only main and beta branches.
Documentation
- Clarified that stable releases publish from the main branch and prerelease versions from the beta branch.
Tests
- Updated release configuration tests to reflect the new branch strategy.

qodo-code-review · 2026-04-04T15:09:21Z

Review Summary by Qodo

Remove master branch references and refresh README badges

📝 Documentation ✨ Enhancement

Walkthroughs

Description

• Remove master branch references from workflows and configs
• Center README badges and add CodeQL and npm downloads badges
• Update maintenance notes to reflect main as default branch
• Align repo-only release policy to main and beta branches

Diagram

flowchart LR
  A["master branch<br/>references"] -->|removed| B["Workflows and<br/>configs updated"]
  C["README badges"] -->|centered and<br/>enhanced| D["Added CodeQL and<br/>npm downloads badges"]
  E["Maintenance notes"] -->|updated| F["Reflect main as<br/>default branch"]
  B --> G["Repository aligned<br/>to main + beta"]
  D --> G
  F --> G

File Changes

1. readme.md 📝 Documentation +9/-4

Center badges and add CodeQL and downloads badges

• Center badge block with align="center" attribute
• Add CodeQL analysis workflow badge
• Add npm downloads badge
• Update maintenance notes to reflect main as default branch and remove master transition guidance

readme.md

2. release.repo.config.js ⚙️ Configuration changes +0/-1

Remove master from release branch policy
• Remove master branch from repo-only release configuration
• Keep main as latest channel and beta as prerelease
release.repo.config.js

3. test/release-config.test.js 🧪 Tests +0/-1

Update branch policy test for main only
• Update test assertion to remove master branch expectation
• Verify repo-only branch policy now only includes main and beta
test/release-config.test.js

View more (3)

4. .github/workflows/ci.yml ⚙️ Configuration changes +0/-2

Remove master from CI workflow triggers
• Remove master branch from pull_request trigger
• Remove master branch from push trigger
• Keep main and beta branches for CI workflow
.github/workflows/ci.yml

5. .github/workflows/codeql-analysis.yml ⚙️ Configuration changes +2/-2

Remove master from CodeQL workflow triggers
• Remove master branch from push trigger, keep only main
• Remove master branch from pull_request trigger, keep only main
.github/workflows/codeql-analysis.yml

6. .github/workflows/release.yml ⚙️ Configuration changes +0/-1

Remove master from release workflow triggers
• Remove master branch from push trigger
• Keep main and beta branches for release workflow
.github/workflows/release.yml

qodo-code-review · 2026-04-04T15:09:22Z

Code Review by Qodo

🐞 Bugs (2) 📘 Rule violations (0) 📎 Requirement gaps (0) 🎨 UX Issues (0)

1. CodeQL skips beta branch 🐞 Bug ⛨ Security

Description

The CodeQL workflow now only triggers on main, so pushes/PRs targeting beta (a configured
prerelease publishing branch) will not be CodeQL-scanned. This reduces security coverage for code
that is actually published from beta.

Code

.github/workflows/codeql-analysis.yml[R16-19]

+    branches: [ main ]
  pull_request:
    # The branches below must be a subset of the branches above
-    branches: [ master, main ]
+    branches: [ main ]

Evidence
codeql-analysis.yml is restricted to main only, while both the release workflow and
semantic-release repo config treat beta as a release branch; therefore beta changes can be
published without CodeQL analysis.
.github/workflows/codeql-analysis.yml[14-20]
.github/workflows/release.yml[3-8]
release.repo.config.js[3-9]
readme.md[122-126]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
CodeQL analysis is only triggered for the `main` branch, but this repository publishes prereleases from `beta`. As a result, `beta` changes can be released without CodeQL scanning.

## Issue Context
Other automation (CI and release) is configured to run on `beta`, and `release.repo.config.js` explicitly configures `beta` as a prerelease branch.

## Fix Focus Areas
- .github/workflows/codeql-analysis.yml[14-20]

## Suggested change
Add `beta` to the `on.push.branches` and `on.pull_request.branches` lists (or otherwise ensure CodeQL runs for the `beta` publishing branch as well).

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

2. Master branch docs still present 🐞 Bug ⚙ Maintainability

Description

After removing master from the repo-only release branches, docs/release-channels.md still claims
that master publishes stable releases, which is now incorrect. This creates documentation drift
and conflicts with the updated branch policy described in the README.

Code

release.repo.config.js[R5-8]

	branches: [
-		{name: 'master', channel: 'latest'},
		{name: 'main', channel: 'latest'},
		{name: 'beta', prerelease: 'beta'},
	],

Evidence

The repo-only semantic-release config no longer includes a master branch, but the release-channels
documentation still states that master publishes stable releases, so the documentation is now
inaccurate relative to the actual config.

release.repo.config.js[3-9]
docs/release-channels.md[1-8]
readme.md[122-127]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
Documentation in `docs/release-channels.md` still states that `master` publishes stable releases, but the repo-only release config removed `master`.

## Issue Context
This PR’s changes make `main` the stable release branch and `beta` the prerelease branch; docs should match this to avoid sending maintainers/users to a non-existent/unsupported branch.

## Fix Focus Areas
- docs/release-channels.md[1-8]

## Suggested change
Rewrite the stable-release bullet to reference only `main` (and keep `beta` for prereleases), and remove the “migration window” wording tied to `master`.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

ⓘ The new review experience is currently in Beta. Learn more

coderabbitai · 2026-04-04T15:09:46Z

Warning

Rate limit exceeded

@oleg-koval has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 5 minutes and 15 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 5 minutes and 15 seconds.

⌛ 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: d541bda3-6b69-4fce-9889-1f6909a32940

📥 Commits

Reviewing files that changed from the base of the PR and between 4a1ae4a and 200686b.

📒 Files selected for processing (1)

readme.md

📝 Walkthrough

Walkthrough

The pull request removes the master branch from CI/CD workflow triggers, release configuration, and documentation. Workflows now run only on main and beta branches. The release configuration and related tests are updated to reflect this branch structure change.

Changes

Cohort / File(s)	Summary
GitHub Actions Workflows `.github/workflows/ci.yml`, `.github/workflows/codeql-analysis.yml`, `.github/workflows/release.yml`	Removed `master` branch from workflow trigger conditions for both `push` and `pull_request` events, leaving only `main` and `beta` as monitored branches.
Release Configuration `release.repo.config.js`	Removed the `master` branch entry (`{name: 'master', channel: 'latest'}`) from the exported `branches` array, retaining only `main` and `beta` entries.
Documentation `readme.md`	Updated "Repository Maintenance Notes" to reflect that stable releases publish from `main` and prereleases from `beta`, with `main` established as the default branch for all badges and examples.
Tests `test/release-config.test.js`	Removed `master` branch entry from expected `repoReleaseConfig.branches` array in test assertions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

PR #57: Directly modifies the same workflow triggers and release configuration files; this PR removes the master branch entries that #57 previously introduced.
PR #56: Updates the same release/CI configuration files and documentation; this PR reverses the master branch additions from that PR.

Poem

🐰 Thump thump! The master branch must go,
Main and beta steal the show,
Workflows clean and code pristine,
Branches trim, well-defined, lean! 🌿

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically summarizes the main changes: README badge refresh and branch guidance alignment by removing master branch references.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ 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 feat/readme-refresh-main-badges

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

## [1.7.2](v1.7.1...v1.7.2) (2026-04-04) ### 📚 Documentation * **readme:** refresh badges and branch guidance ([#58](#58)) ([5b82595](5b82595))

github-actions · 2026-04-04T15:27:16Z

🎉 This PR is included in version 1.7.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

* ci(dependabot): add lockfile fixer workflow (#59) * release(version): Release 1.7.1 [skip ci] ## [1.7.1](v1.7.0...v1.7.1) (2026-04-04) ### ⚙️ Continuous Integrations * **dependabot:** add lockfile fixer workflow ([#59](#59)) ([287745b](287745b)) * docs(readme): refresh badges and branch guidance (#58) * release(version): Release 1.7.2 [skip ci] ## [1.7.2](v1.7.1...v1.7.2) (2026-04-04) ### 📚 Documentation * **readme:** refresh badges and branch guidance ([#58](#58)) ([5b82595](5b82595)) * fix(ci): run lockfile fixer for reopened dependabot prs * fix(ci): run lockfile fixer for reopened dependabot prs * ci(dependabot): auto-merge safe npm updates * docs(release): clarify branch migration and defaults * release(version): Release 1.7.3 [skip ci] ## [1.7.3](v1.7.2...v1.7.3) (2026-04-04) ### 🐛 Bug Fixes * **ci:** run lockfile fixer for reopened dependabot prs ([cea37bf](cea37bf)) --------- Co-authored-by: semantic-release-bot <semantic-release-bot@martynus.net>

…dates (#61) * ci(dependabot): add lockfile fixer workflow (#59) * release(version): Release 1.7.1 [skip ci] ## [1.7.1](v1.7.0...v1.7.1) (2026-04-04) ### ⚙️ Continuous Integrations * **dependabot:** add lockfile fixer workflow ([#59](#59)) ([287745b](287745b)) * docs(readme): refresh badges and branch guidance (#58) * release(version): Release 1.7.2 [skip ci] ## [1.7.2](v1.7.1...v1.7.2) (2026-04-04) ### 📚 Documentation * **readme:** refresh badges and branch guidance ([#58](#58)) ([5b82595](5b82595)) * fix(ci): run lockfile fixer for reopened dependabot prs * fix(ci): run lockfile fixer for reopened dependabot prs * ci(dependabot): auto-merge safe npm updates * docs(release): clarify branch migration and defaults * release(version): Release 1.7.3 [skip ci] ## [1.7.3](v1.7.2...v1.7.3) (2026-04-04) ### 🐛 Bug Fixes * **ci:** run lockfile fixer for reopened dependabot prs ([cea37bf](cea37bf)) * chore(deps): bump the npm_and_yarn group across 1 directory with 3 updates Bumps the npm_and_yarn group with 3 updates in the / directory: [braces](https://github.com/micromatch/braces), [lodash](https://github.com/lodash/lodash) and [picomatch](https://github.com/micromatch/picomatch). Updates `braces` from 3.0.2 to 3.0.3 - [Changelog](https://github.com/micromatch/braces/blob/master/CHANGELOG.md) - [Commits](micromatch/braces@3.0.2...3.0.3) Updates `lodash` from 4.17.21 to 4.18.1 - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](lodash/lodash@4.17.21...4.18.1) Updates `picomatch` from 2.3.0 to 2.3.2 - [Release notes](https://github.com/micromatch/picomatch/releases) - [Changelog](https://github.com/micromatch/picomatch/blob/master/CHANGELOG.md) - [Commits](micromatch/picomatch@2.3.0...2.3.2) --- updated-dependencies: - dependency-name: braces dependency-version: 3.0.3 dependency-type: indirect dependency-group: npm_and_yarn - dependency-name: lodash dependency-version: 4.18.1 dependency-type: indirect dependency-group: npm_and_yarn - dependency-name: picomatch dependency-version: 2.3.2 dependency-type: indirect dependency-group: npm_and_yarn ... Signed-off-by: dependabot[bot] <support@github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: oleg koval <5700359+oleg-koval@users.noreply.github.com> Co-authored-by: semantic-release-bot <semantic-release-bot@martynus.net> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

## [1.7.4-beta.1](v1.7.3...v1.7.4-beta.1) (2026-04-04) ### ♻️ Chores * **deps:** bump the npm_and_yarn group across 1 directory with 3 updates ([#61](#61)) ([82f69fc](82f69fc)), closes [#59](#59) [#58](#58)

docs(readme): refresh badges and branch guidance

4a1ae4a

Merge branch 'main' into feat/readme-refresh-main-badges

200686b

oleg-koval merged commit 5b82595 into main Apr 4, 2026
8 checks passed

oleg-koval deleted the feat/readme-refresh-main-badges branch April 4, 2026 15:26

github-actions Bot pushed a commit that referenced this pull request Apr 4, 2026

release(version): Release 1.7.2 [skip ci]

c120da0

## [1.7.2](v1.7.1...v1.7.2) (2026-04-04) ### 📚 Documentation * **readme:** refresh badges and branch guidance ([#58](#58)) ([5b82595](5b82595))

github-actions Bot added the released on @latest label Apr 4, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refresh README badges and align branch guidance#58

Refresh README badges and align branch guidance#58
oleg-koval merged 2 commits intomainfrom
feat/readme-refresh-main-badges

oleg-koval commented Apr 4, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

qodo-code-review Bot commented Apr 4, 2026

Uh oh!

qodo-code-review Bot commented Apr 4, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Apr 4, 2026 •

edited

Loading

Rate limit exceeded

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Uh oh!

Uh oh!

github-actions Bot commented Apr 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

oleg-koval commented Apr 4, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Problem

Solution

Changes

Out of scope

Related issues

Validation

Screenshots / Demo

Risk and impact

Breaking changes

Documentation

Reviewer notes

Summary by CodeRabbit

Uh oh!

qodo-code-review Bot commented Apr 4, 2026

Review Summary by Qodo

Walkthroughs

File Changes

Uh oh!

qodo-code-review Bot commented Apr 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review by Qodo

Uh oh!

coderabbitai Bot commented Apr 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Uh oh!

Uh oh!

github-actions Bot commented Apr 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

oleg-koval commented Apr 4, 2026 •

edited by coderabbitai Bot

Loading

qodo-code-review Bot commented Apr 4, 2026 •

edited

Loading

coderabbitai Bot commented Apr 4, 2026 •

edited

Loading