Skip to content

Conversation

mertssmnoglu
Copy link
Contributor

@mertssmnoglu mertssmnoglu commented May 30, 2025

Update examples to Node.js 22(LTS) and modernize Docker Compose syntax.

Description

Node.js Version

  • Updated node:8 and node:16 image tags to node:22 in README.

Docker Compose

  • I removed explicit version declaration, which is no longer required in docker compose.
  • Synced the node version to 22.
  • Switch command to array syntax for clarity.
  • Align ports with Dockerfile example port 8888.
  • Drop expose field for simplicity.

Motivation and Context

As a developer, I would like to see latest LTS version in the documentation with the up to date Docker Compose example.

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.

@mertssmnoglu
Copy link
Contributor Author

mertssmnoglu commented May 30, 2025

I'm also thinking about updating docker compose example too. Is it OK to do it in this PR?

services:
  node:
    image: "node:22"
    environment:
      - NODE_ENV=production
    volumes:
      - ./:/home/node/app
    ports: # use if it is necessary to expose the container to the host machine
      - "8081:8081"
    command: ["npm", "start"]

@SimenB
Copy link
Member

SimenB commented Jul 16, 2025

I'm also thinking about updating docker compose example too. Is it OK to do it in this PR?

services:
  node:
    image: "node:22"
    environment:
      - NODE_ENV=production
    volumes:
      - ./:/home/node/app
    ports: # use if it is necessary to expose the container to the host machine
      - "8081:8081"
    command: ["npm", "start"]

Yes please 🙂

@mertssmnoglu mertssmnoglu marked this pull request as ready for review July 24, 2025 10:23
@mertssmnoglu mertssmnoglu force-pushed the readme-node-version branch from 84f117e to d9df67d Compare July 24, 2025 10:35
@PeterDaveHello PeterDaveHello requested a review from Copilot August 1, 2025 11:41
Copilot

This comment was marked as outdated.

@PeterDaveHello
Copy link
Member

@coderabbitai, could you provide a better PR subject and description?

@PeterDaveHello
Copy link
Member

Summary from GitHub Copilot:

This pull request updates the Node.js version used in the Docker configurations and examples within the README.md file. The changes ensure consistency across the documentation and upgrade the Node.js version to 22.

Updates to Node.js version in Docker configurations:

  • Updated the Node.js base image in the Dockerfile example from node:16 to node:22. (README.md, README.mdL55-R55)
  • Modified the Docker Compose example to use node:22 as the image, updated the exposed port to 8888, and adjusted the command syntax to use an array format. (README.md, README.mdL70-R79)
  • Updated the standalone Docker command example to use node:22 instead of node:8. (README.md, README.mdL108-R103)

Copy link
Member

@PeterDaveHello PeterDaveHello left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also include any related changes in the PR title and description, not just the Node.js version. Thank you.

@mertssmnoglu mertssmnoglu changed the title docs: update nodejs versions to 22 in README.md docs: update examples to Node.js 22 and modernize Docker Compose syntax Aug 8, 2025
@mertssmnoglu
Copy link
Contributor Author

Hi @PeterDaveHello I updated the title and description. Sorry for the untested changes like deleting user and working_dir specifications. I suggest accepting the Copilot's commit #2243 (comment)

@PeterDaveHello PeterDaveHello marked this pull request as draft August 10, 2025 06:14
@PeterDaveHello
Copy link
Member

@mertssmnoglu no problem, just let me know when it's ready.

@mertssmnoglu mertssmnoglu marked this pull request as ready for review August 13, 2025 08:37
@mertssmnoglu
Copy link
Contributor Author

@mertssmnoglu no problem, just let me know when it's ready.

It's ready right now.

@PeterDaveHello PeterDaveHello requested a review from a team August 13, 2025 18:40
@PeterDaveHello PeterDaveHello requested a review from Copilot August 21, 2025 15:03
Copilot

This comment was marked as outdated.

@PeterDaveHello PeterDaveHello changed the title docs: update examples to Node.js 22 and modernize Docker Compose syntax docs: Update Node.js to v22 and usage examples in README.md Aug 23, 2025
@PeterDaveHello PeterDaveHello requested a review from Copilot August 23, 2025 15:47
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Updates the Node.js documentation to use version 22 (LTS) instead of older versions and modernizes Docker Compose syntax to follow current best practices.

  • Updated Node.js version references from v8/v16 to v22 across all examples
  • Modernized Docker Compose configuration by removing deprecated version field and improving syntax
  • Aligned port configurations between Dockerfile and Docker Compose examples for consistency

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Updates the documentation to use version 22 (LTS) instead of older
versions, and modernizes Docker Compose syntax:

- Bump all Node.js version references to 22
- Align ports and commands in Docker Compose example for consistency
- Remove deprecated fields from Docker Compose example

This keeps documentation up to date and reduces confusion for users.

Signed-off-by: Mert Şişmanoğlu <[email protected]>
@PeterDaveHello PeterDaveHello merged commit 0e2ac1c into nodejs:main Aug 23, 2025
3 checks passed
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.

3 participants