Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates
CONTRIBUTING.mdandREADME.mdto reflect the automated dependency management and release pipeline introduced inci/dependabot-auto-release. Both documents now accurately describe the full end-to-end flow — from a Dependabot Node.js version bump through auto-merge, release branch creation, tagging, and GitHub Release publication — so that contributors and users have a complete and accurate reference.Additionally, the table of contents has been removed from
CONTRIBUTING.mdas a housekeeping improvement, and theRelease Processsection has been rewritten to describe the new fully automated flow rather than the previous manual tag-push process.Files Changed
Added:
Modified:
CONTRIBUTING.mdREADME.mdDeleted:
Key Changes
CONTRIBUTING.md.Automated Dependency Managementsection toCONTRIBUTING.mddocumenting all four pipeline stages: Dependabot daily Docker monitoring, auto-merge ondependencies-labelled PRs, therelease-from-developworkflow that constructs therelease/v<semver>-<node_version>branch and opens a PR tomain, and thetag-and-releaseworkflow that creates an annotated Git tag and publishes a GitHub Release.VERSION Filesubsection toCONTRIBUTING.mdexplaining thatVERSIONis the single source of truth for the SemVer component and that major or minor bumps require a manual update toVERSIONbefore the next Dependabot cycle.Release Processsection inCONTRIBUTING.mdfrom a manual tag-push description to a numbered seven-step automated flow, ending with the deployment workflow publishing the multi-arch image to Docker Hub and GHCR with provenance attestations and an SBOM.Release Processfrom "can push tags tomainand trigger a release" to "can merge the release PR intomainand trigger a release", accurately reflecting the new flow.Automated Dependency Management & Releaseparagraph to the CI/CD Quality Guarantees section inREADME.md, describing the full automated pipeline — Dependabot → auto-merge →release-from-develop→tag-and-release— and noting that SemVer bumps require a manualVERSIONfile update.CONTRIBUTING.md.