Skip to content

Commit 68c7c27

Browse files
authored
Merge the "docs/update-documentation" branch into the "develop-v1+node24" branch
This merge updates `README.md` on the `develop-v1+node24` line to make the versioning examples consistent with how Runtime Node tags appear in GitHub Releases versus container registries. It also refreshes the size badge and the builder-stage example so the documentation reflects the current image constraints more precisely. In the centered header block, the size badge is updated from `~45MB` to `<50MB`. In the Quickstart section, the Docker Hub and GHCR versioned pull examples are updated from `v<image_semver>+node<node_version>` to `v<major>.<minor>.<patch>-node<node_version>`, and the versioned `FROM runtimenode/runtime-node:...` example is updated to the same normalized registry tag format. In the versioned builder example, `FROM node:<node_version>-alpine AS builder` is updated to `FROM node:<node_version>-alpine3.23 AS builder`. In the Versioning and Tags section, the documented tag pattern is updated from `v<image_semver>+node<node_version>` with example `v1.2.3+node24.14.1` to `v<major>.<minor>.<patch>+node<node_version>` with example `v1.2.4+node24.14.1`, and a new note is added explaining that `docker/metadata-action` normalizes `+` to `-` in published registry tags. No other files or documentation sections are modified by this merge.
2 parents 890b06b + d22ca93 commit 68c7c27

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
[![Docker Hub](https://img.shields.io/docker/pulls/runtimenode/runtime-node?label=Docker%20Hub)](https://hub.docker.com/r/runtimenode/runtime-node)
1111
[![GHCR](https://img.shields.io/badge/GHCR-ghcr.io%2FRuntimes--Node%2Fruntime--node-blue)](https://github.com/Runtimes-Node/Runtime-Node/pkgs/container/runtime-node)
1212
[![Platforms](https://img.shields.io/badge/platforms-linux%2Famd64%20%7C%20linux%2Farm64-lightgrey)](https://hub.docker.com/r/runtimenode/runtime-node)
13-
[![Size](https://img.shields.io/badge/size-%7E45MB-green)](https://hub.docker.com/r/runtimenode/runtime-node)
13+
[![Size](https://img.shields.io/badge/size-%3C50MB-green)](https://hub.docker.com/r/runtimenode/runtime-node)
1414
[![Vulnerabilities](https://img.shields.io/badge/vulnerabilities-0-brightgreen)](https://hub.docker.com/r/runtimenode/runtime-node)
1515

1616
</div>
@@ -70,7 +70,7 @@ These are the two primary size-focused official variants documented by the Node
7070

7171
```bash
7272
# Pull the versioned published tag
73-
docker pull runtimenode/runtime-node:v<image_semver>+node<node_version>
73+
docker pull runtimenode/runtime-node:v<major>.<minor>.<patch>-node<node_version>
7474
```
7575

7676
- Latest (Not Recommended for Production):
@@ -86,7 +86,7 @@ docker pull runtimenode/runtime-node:latest
8686

8787
```bash
8888
# Pull the versioned published tag
89-
docker pull ghcr.io/runtimes-node/runtime-node:v<image_semver>+node<node_version>
89+
docker pull ghcr.io/runtimes-node/runtime-node:v<major>.<minor>.<patch>-node<node_version>
9090
```
9191

9292
- Latest (Not Recommended for Production):
@@ -102,7 +102,7 @@ docker pull ghcr.io/runtimes-node/runtime-node:latest
102102

103103
```Dockerfile
104104
# Use the same Node.js version as your final runtime stage base image
105-
FROM node:<node_version>-alpine AS builder
105+
FROM node:<node_version>-alpine3.23 AS builder
106106

107107
WORKDIR /dist
108108

@@ -111,7 +111,7 @@ COPY ./ ./
111111
RUN npm ci --omit=dev --no-cache
112112

113113
# Use the same Node.js version as your builder stage base image
114-
FROM runtimenode/runtime-node:v<image_semver>+node<node_version>
114+
FROM runtimenode/runtime-node:v<major>.<minor>.<patch>-node<node_version>
115115

116116
# Copy your production build artifacts only
117117
COPY --from=builder --chmod=555 dist/ /app/
@@ -175,11 +175,13 @@ Applications that need a different timezone can set `TZ` at runtime (timezone da
175175
## Versioning and Tags
176176

177177
Tags follow the pattern:
178-
- `v<image_semver>+node<node_version>` (example: `v1.2.3+node24.14.1`)
178+
- `v<major>.<minor>.<patch>+node<node_version>` (example: `v1.2.4+node24.14.1`)
179179
- `latest` tracks the most recent release.
180180

181181
Check the GitHub Releases page for the current tag and Node.js version.
182182

183+
> Because of the `docker/metadata-action`, all tags with `+`, turns into `-` (example: GitHub Releases `v1.2.4+node24.14.1` then it becomes `v1.2.4-node24.14.1` in the Docker Hub and GitHub Container Registry)
184+
183185
## Security Posture
184186

185187
Runtime Node is built to minimize the attack surface:

0 commit comments

Comments
 (0)