Skip to content

Fixed 'README.md' inconsistencies and corrected 'versions.js' newline accumulation.#387

Merged
AlexSkrypnyk merged 3 commits into
mainfrom
feature/readme-fixes
May 21, 2026
Merged

Fixed 'README.md' inconsistencies and corrected 'versions.js' newline accumulation.#387
AlexSkrypnyk merged 3 commits into
mainfrom
feature/readme-fixes

Conversation

@AlexSkrypnyk
Copy link
Copy Markdown
Member

@AlexSkrypnyk AlexSkrypnyk commented May 21, 2026

Summary

README.md contained several factual errors and formatting inconsistencies that had accumulated over time. A root cause was a bug in versions.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.md

  • Corrected the Testing section: the image does not bundle Goss; Goss runs from the host via dgoss against the built image. The previous wording was factually wrong.
  • Unified the two drevops/ci-runner:<tag> usage examples to the same version (25.8.0); the plain Usage snippet was lagging behind the GitHub Actions snippet.
  • Added language identifiers (text, yaml) to three fenced code blocks (markdownlint MD040).
  • Added the missing blank line before ## Usage.
  • Bumped the year example in the Versioning section from 2023 to 2025.
  • Removed ~130 accumulated trailing blank lines, leaving a single trailing newline.

versions.js

  • After writing the replaced section content, the script now pushes an explicit blank-line separator before the next ## heading. Previously the skip-loop consumed the original blank line without replacing it, so every regenerated README had no separation between sections.
  • Replaced result.join('\n') + "\n\n" with result.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 for Node.js, npm, and npx versions 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

  • Updated usage instructions with latest image tag (25.8.0)
  • Clarified Goss testing procedures in documentation
  • Updated versioning examples to 2025 format

Chores

  • Enhanced README generation formatting

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 21, 2026

No actionable comments were generated in the recent review. πŸŽ‰

ℹ️ Recent review info
βš™οΈ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: a2942f4b-b995-4bae-a16b-f7ee8f7c9c0d

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 863c2ab and 6cd123c.

πŸ“’ Files selected for processing (2)
  • README.md
  • versions.js

πŸ“ Walkthrough

Walkthrough

This PR updates the README documentation to reflect the latest pinned Docker image version (25.8.0), clarifies testing instructions regarding Goss usage, and refreshes versioning examples to 2025. It also adjusts the README generation logic in versions.js to properly handle blank line insertion and trailing newline normalization.

Changes

README Documentation and Generation

Layer / File(s) Summary
README documentation updates
README.md
Pinned Docker image tag bumped from 25.1.0 to 25.8.0 in the Usage section. Testing section clarified to specify Goss is used from the host via dgoss and is not bundled in the image. Versioning examples updated from 23.4.2 (2023) to 25.4.2 (2025) format.
README generation formatting logic
versions.js
updateReadme() now inserts an extra blank line after newly generated section content, and changes final README trailing newline handling from unconditionally appending double newlines to trimming trailing newlines to exactly one via regex replacement.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • drevops/ci-runner#384: Modifies README.md version/tag information and trailing blank lines with similar README content overlap.
  • drevops/ci-runner#376: Adjusts README generation and blank-line placement at EOF alongside version-related content updates.
  • drevops/ci-runner#382: Updates Docker image and package version tags in README.md with minor whitespace adjustments.
πŸš₯ Pre-merge checks | βœ… 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
βœ… Passed checks (4 passed)
Check name Status Explanation
Description Check βœ… Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check βœ… Passed The title accurately reflects the main changes: fixing README.md inconsistencies (clarifications, tag updates, formatting) and correcting newline handling in versions.js.
Linked Issues check βœ… Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check βœ… Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
πŸ“ Generate docstrings
  • Create stacked PR
  • Commit on current branch
πŸ§ͺ Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/readme-fixes

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

@AlexSkrypnyk AlexSkrypnyk merged commit bd6a31f into main May 21, 2026
3 checks passed
@AlexSkrypnyk AlexSkrypnyk deleted the feature/readme-fixes branch May 21, 2026 21:01
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