Fixed 'README.md' inconsistencies and corrected 'versions.js' newline accumulation.#387
Merged
Conversation
|
No actionable comments were generated in the recent review. π βΉοΈ Recent review infoβοΈ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: π Files selected for processing (2)
π WalkthroughWalkthroughThis PR updates the README documentation to reflect the latest pinned Docker image version ( ChangesREADME Documentation and Generation
Estimated code review effortπ― 2 (Simple) | β±οΈ ~10 minutes Possibly related PRs
π₯ Pre-merge checks | β 4 | β 1β Failed checks (1 warning)
β Passed checks (4 passed)
βοΈ Tip: You can configure your own custom pre-merge checks in the settings. β¨ Finishing Touchesπ Generate docstrings
π§ͺ Generate unit tests (beta)
Comment |
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
README.mdcontained several factual errors and formatting inconsistencies that had accumulated over time. A root cause was a bug inversions.js: each automated update run appended extra trailing newlines and dropped the blank line between the generated packages section and the next heading. Over many runs this caused ~130 trailing blank lines to accumulate. This PR corrects both the README content directly and patches the script so the rot cannot recur.Changes
README.mddgossagainst the built image. The previous wording was factually wrong.drevops/ci-runner:<tag>usage examples to the same version (25.8.0); the plain Usage snippet was lagging behind the GitHub Actions snippet.text,yaml) to three fenced code blocks (markdownlint MD040).## Usage.versions.js##heading. Previously the skip-loop consumed the original blank line without replacing it, so every regenerated README had no separation between sections.result.join('\n') + "\n\n"withresult.join('\n').replace(/\n*$/, '\n'). The old code unconditionally appended two newlines on every run; combined with split/join semantics on a newline-terminated file, this added two trailing blank lines per regeneration cycle - the source of the ~130 line accumulation.Note on commit history
The branch has three commits. Commit 2 (
Restored 'Node.js', 'npm', 'npx' versions in 'README.md'.) walks back a version regression accidentally introduced in commit 1. The net diff forNode.js,npm, andnpxversions across the PR is zero - those three packages are untouched in the final state. The intermediate commit is noise and can be ignored during review.Summary by CodeRabbit
Documentation
Chores