Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,6 @@ jobs:
exit 1
fi

PACKAGE_VERSION="$(node -p "require('./package.json').version")"
if [ "${PACKAGE_VERSION}" != "${VERSION}" ]; then
echo "Tag version ${VERSION} does not match package.json version ${PACKAGE_VERSION}" >&2
exit 1
fi

{
echo "version=${VERSION}"
echo "major=${MAJOR}"
Expand Down
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

The Makefile mirrors those workflows with `make install`, `make start`, `make lint`, `make lint-fix`, `make helm-lint`, `make helm-template`, `make helm-verify`, `make build-container`, `make run-container`, `make release-tag`, and `make example-request`.

`package.json` is the single source of truth for the service version. Release publishing is tag-driven: bump `package.json`'s `version`, commit it, create a matching `vX.Y.Z` tag, and push the tag to trigger Docker publish plus GitHub Release creation.
Release publishing is tag-driven: create a matching `vX.Y.Z` git tag and push it to trigger Docker publish plus GitHub Release creation. The service version is no longer stored in `package.json`.

## Testing expectations

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ make install
make start
```

Release versions come from [`package.json`](package.json). To publish a release, bump `version`, commit the change, create a `vX.Y.Z` tag, and push that tag. The release workflow publishes Docker images for `X.Y.Z`, `X.Y`, `X`, and `latest`, and creates the matching GitHub Release with generated notes.
Release versions come from the git tag (`vX.Y.Z`). To publish a release, create a `vX.Y.Z` tag and push it. The release workflow publishes Docker images for `X.Y.Z`, `X.Y`, `X`, and `latest`, and creates the matching GitHub Release with generated notes.

## Helm chart

Expand All @@ -149,7 +149,7 @@ Artifact Hub should reference the external Helm repository URL `https://phpdocke

## Release and versioning

Docker image publishing remains tag-driven. Bump [`package.json`](package.json), commit it, create the matching `vX.Y.Z` tag, and push the tag to publish the container image and GitHub Release.
Docker image publishing remains tag-driven. Create the matching `vX.Y.Z` tag and push it to publish the container image and GitHub Release.

Helm chart publishing is separate and runs from chart changes on `master` or an explicit manual trigger. It packages changed charts from `charts/`, updates the GitHub Pages repository on `gh-pages`, and publishes `artifacthub-repo.yml` next to `index.yaml` for Artifact Hub.

Expand Down
2 changes: 1 addition & 1 deletion charts/readability-js-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Chart and application versions are intentionally separate:

When the chart changes without a new application release, only the chart `version` should move. When the default image tag changes, bump both the chart `version` and `appVersion`.

Docker image publishing remains tag-driven from the root release workflow and follows `package.json`. Helm chart publishing is separate: pushes to `master` that change `charts/**`, plus explicit manual workflow runs, publish the chart repository to GitHub Pages.
Docker image publishing remains tag-driven from the root release workflow and follows the git tag. Helm chart publishing is separate: pushes to `master` that change `charts/**`, plus explicit manual workflow runs, publish the chart repository to GitHub Pages.

## Hosted repository and Artifact Hub

Expand Down
1 change: 0 additions & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
{
"name": "readability-js-server",
"version": "1.8.0",
"description": "Mozilla's Readability.js as a service",
"author": "Luis Pabon @ phpdocker.io",
"homepage": "https://github.com/phpdocker-io/readability-js-server",
Expand Down
3 changes: 1 addition & 2 deletions src/server.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
const { loadConfig } = require("./config");
const app = require("./app");
const { version } = require("../package.json");

const config = loadConfig();

Expand All @@ -18,7 +17,7 @@ function logError(message, error) {

const shutdownTimeoutMs = 10_000;
const server = app.listen(config.port, () => {
log(`Readability.js server v${version} listening on port ${config.port}!`);
log(`Readability.js server listening on port ${config.port}!`);
});

let isShuttingDown = false;
Expand Down
Loading