Skip to content

docs: update README and CONTRIBUTING to reflect Node.js 25.7.0 and manual release process#10

Merged
Amnoor merged 1 commit intodevelopfrom
docs/update-documentation
Feb 27, 2026
Merged

docs: update README and CONTRIBUTING to reflect Node.js 25.7.0 and manual release process#10
Amnoor merged 1 commit intodevelopfrom
docs/update-documentation

Conversation

@Amnoor
Copy link
Contributor

@Amnoor Amnoor commented Feb 27, 2026

Summary

This PR updates README.md and CONTRIBUTING.md to reflect the current state of the repository following the merges of ci/dependabot-auto-release and ci/remove-unnecessary-automation. All references to the removed automation workflows (auto-merge-dependabot, release-from-develop, tag-and-release) and the VERSION file are removed from both documents. Node.js version references are bumped from 24.13.1 to 25.7.0 throughout, and the release process documentation is rewritten to describe the correct manual flow that is now in place.

Files Changed

Added:

  • None

Modified:

  • CONTRIBUTING.md
  • README.md

Deleted:

  • None

Key Changes

  • Updated commit and PR title examples in CONTRIBUTING.md from 24.14.0 to 25.7.0 to reflect the current Node.js version.
  • Removed the Automated Dependency Management section and VERSION File subsection from CONTRIBUTING.md, which documented the now-deleted automation workflows.
  • Rewrote the Release Process section in CONTRIBUTING.md from the former automated seven-step flow to a manual five-step flow: create a release/v<semver>-<node_version> branch off develop, open a PR to main, merge it, push the version tag, and let the deployment workflow publish the image.
  • Updated the Dockerfile Constraints version example in CONTRIBUTING.md from node:24.13.1-alpine3.22 to node:25.7.0-alpine3.22.
  • Updated the Node.js Version entry in the Key Features table in README.md from 24.13.1 to 25.7.0.
  • Updated the Usage section Dockerfile examples in README.md: builder stage from node:24.13.1-alpine3.22 to node:25.7.0-alpine3.22, and final stage from runtimenode/runtime-node:v1.0.0-24.13.1 to runtimenode/runtime-node:v2.0.0-25.7.0.
  • Updated the "Pinning to a Specific Version" example tag in README.md from v1.0.0-24.13.1 to v2.0.0-25.7.0.
  • Removed the Automated Dependency Management & Release paragraph from the CI/CD & Quality Guarantees section in README.md.
  • Updated the Versioning section in README.md to remove the reference to the VERSION file and updated the example tag from v1.0.0-24.13.1 to v2.0.0-25.7.0.
  • Removed peter-evans/create-pull-request and actions/create-release from the Acknowledgements section in README.md, as neither workflow that used them exists any longer.

@Amnoor Amnoor merged commit 5b2e3e1 into develop Feb 27, 2026
3 checks passed
@Amnoor Amnoor deleted the docs/update-documentation branch February 27, 2026 12:21
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