ENGCB-379 - Update README file with Publishing instructions.

[eduardoyuidy]

Description of changes

• Updated README.md publishing instructions:
  • Alpha versions: Replaced neo library publish (CodeBuild) with npm publish --tag alpha (manual).
  • Beta versions: Replaced automatic CodeBuild trigger on merge to release-candidate branches with npm publish --tag beta (manual).
  • Stable versions: Replaced automatic GitHub Actions + CodeBuild pipeline with npm publish --tag latest (manual).
  • Added a note about requiring access to the NPM Publisher List for all publish flows.

Why

As this public repository we won't be using automatic publishing through the package publisher CodeBuild pipeline. - Relevant thread with Cyber Sec (Private channel)

Related PRs

• https://github.com/neofinancial/terraform-neo/pull/15305
• ENGCB-379 - Remove automatic publish + package yaml. eslint-config-neo#55

Checklist

• [ ] Have you fully tested your PR locally?
• [ ] Have you made a CHANGELOG entry?

Summary by CodeRabbit

• Documentation
  • Updated publishing instructions with three distinct release flows: Alpha (with alpha version tags), Beta/Release Candidate (with PR and release-candidate branch requirements), and Stable (with master branch merge requirement).
  • Added explicit version-format requirements and NPM Publisher List permission notes for each publishing step.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c952f81c-78f1-4003-ae6e-16443f7049e8

📥 Commits

Reviewing files that changed from the base of the PR and between 45e2ac6 and b12f2ba.

📒 Files selected for processing (1)

• README.md

✅ Files skipped from review due to trivial changes (1)

• README.md

---

📝 Walkthrough

Walkthrough

Updated README publishing instructions to replace the previous prerelease note with a three-flow publishing workflow: Alpha (alpha tag, -alpha.x versions), Beta/Release Candidate (beta tag, PRs to release-candidate branches), and Stable (latest tag, merge to master), with explicit version formats and NPM permission notes.

Changes

Cohort / File(s)	Summary
Publishing Documentation README.md	Replaced prior prerelease guidance with a new "Publishing" section describing three flows: Alpha (-alpha.<n>, npm publish --tag alpha), Beta/Release Candidate (-beta.<n>, PR -> release-candidate branch -> npm publish --tag beta), Stable (semver, merge to master, npm publish --tag latest); added version-format requirements and NPM Publisher permission notes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 I hopped through lines of README bright,

Alpha, Beta, Stable all in sight,
Tags set, versions tidy and neat,
Publish steps now crisp and sweet,
— a rabbit's cheer for releases complete!

🚥 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 accurately describes the main change: updating README.md with publishing instructions, which is the sole focus of this documentation-only PR.
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 ENGCB-379/publishing-package-instructions

---

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

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

README.md (1)

36-36: Consider centralizing the NPM Publisher List note to reduce repetition.

The same long parenthetical appears three times. A short shared note (once under ## Publishing) will make steps easier to scan.

Also applies to: 46-46, 55-55

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 36, The three identical parenthetical publisher-note
occurrences after the publish steps (e.g., the one following "Run `npm publish
--tag alpha`") should be removed and replaced with a short pointer like "(see
Publishing note)" in each step, and a single consolidated paragraph titled
"Publishing" should be added (or updated) that contains the full NPM Publisher
List instructions and link; update the instances for the alpha, beta and stable
publish steps to reference that single note to avoid repetition.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 44: Replace the escaped, hard-to-read pattern
"\"\**/*release-candidate\*\"" with a plain inline code glob pattern for
clarity: use `**/*release-candidate*` (no extra backslashes or surrounding
quotes) in the README text so the branch pattern is easy to read and copy.
- Line 40: Fix the subject-verb agreement in the README sentence "services that
uses the library" by changing "uses" to "use" so the line reads "services that
use the library"; locate the phrase in README.md (the sentence starting "In some
rare situations we need to test Library changes versions on a few services in
Production, before rolling out this change to all services that uses the
library.") and update it accordingly.

---

Nitpick comments:
In `@README.md`:
- Line 36: The three identical parenthetical publisher-note occurrences after
the publish steps (e.g., the one following "Run `npm publish --tag alpha`")
should be removed and replaced with a short pointer like "(see Publishing note)"
in each step, and a single consolidated paragraph titled "Publishing" should be
added (or updated) that contains the full NPM Publisher List instructions and
link; update the instances for the alpha, beta and stable publish steps to
reference that single note to avoid repetition.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7595737a-d78f-454e-a69f-123155996c60

📥 Commits

Reviewing files that changed from the base of the PR and between 24913f4 and 45e2ac6.

📒 Files selected for processing (1)

• README.md

[eduardoyuidy]

Won't need this anymore.