Skip to content

fix: correct update.sh script help#2430

Merged
nschonni merged 1 commit intonodejs:mainfrom
MikeMcC399:update-script-help
Mar 27, 2026
Merged

fix: correct update.sh script help#2430
nschonni merged 1 commit intonodejs:mainfrom
MikeMcC399:update-script-help

Conversation

@MikeMcC399
Copy link
Copy Markdown
Contributor

Description

In the update.sh script, update example options to use current Node.js versions and latest Debian release (trixie) and ensure the accuracy of examples.

Motivation and Context

The help text invoked with ./update.sh -h has several inaccuracies.

  • specifying EOL Node.js versions, such as 8, attempts to update all current versions
  • specifying . alpine on its own also attempts to update all variants
  • specifying -s 8 bullseye updates all versions

The combination of -s and Debian variants is redundant. ./update.sh 24 trixie, for example, does not fail when the musl checksum is missing, so adding -s is not needed.

Testing Details

Execute ./update.sh -h and then invoke each one of the listed examples. Confirm that the logs are consistent with the help description.

Example Output

$ ./update.sh -h

  Update the node docker images.

  Usage:
    ./update.sh [-s] [MAJOR_VERSION(S)] [VARIANT(S)]

  Examples:
    - update.sh                           # Update all images
    - update.sh -s                        # Update all images, skip updating Alpine if the musl build is unavailable
    - update.sh 22,24                     # Update all variants of version 22 and 24
    - update.sh -s 24                     # Update all variants of version 24, except skip updating Alpine if the musl build is unavailable
    - update.sh 24 alpine3.22,alpine3.23  # Update only alpine3.22 & alpine3.23 variants for version 24
    - update.sh . trixie,trixie-slim      # Update only trixie & trixie-slim Debian variants for all versions

  OPTIONS:
    -s Security update; allows Debian updates even if musl build for Alpine is unavailable
    -h Show this message

Types of changes

  • Documentation
  • Version change (Update, remove or add more Node.js versions)
  • Variant change (Update, remove or add more variants, or versions of variants)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (none of the above)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING.md document.
  • All new and existing tests passed.

correct and update example options to use current Node.js versions
and latest Debian release
@MikeMcC399 MikeMcC399 marked this pull request as ready for review March 27, 2026 08:21
@nschonni nschonni merged commit a982532 into nodejs:main Mar 27, 2026
3 checks passed
@MikeMcC399 MikeMcC399 deleted the update-script-help branch March 28, 2026 07:29
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.

update -h script help option non-working examples

2 participants