Skip to content

Commit a592f1d

Browse files
authored
Serve the RC2 installer and point RC testers at v1.0-RC2 (#212)
* Serve the RC2 installer Merge only after the v1.0-RC2 release is published: until then its install.sh returns 404 and build:installer fails. Signed-off-by: Guanzhou Song <26541184+GuanzhouSong@users.noreply.github.com> * Point RC testers at v1.0-RC2 and its telemetry opt-out The RC2 documentdb-local image sends anonymous usage telemetry by default; 0.117 images don't. Signed-off-by: Guanzhou Song <26541184+GuanzhouSong@users.noreply.github.com> * Point the versioning post's RC install steps at RC2 Signed-off-by: Guanzhou Song <26541184+GuanzhouSong@users.noreply.github.com> --------- Signed-off-by: Guanzhou Song <26541184+GuanzhouSong@users.noreply.github.com> Co-authored-by: Guanzhou Song <26541184+GuanzhouSong@users.noreply.github.com>
1 parent d209589 commit a592f1d

5 files changed

Lines changed: 22 additions & 16 deletions

File tree

‎PACKAGE-INSTALL.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
Repository-backed installation commands for DocumentDB.
44

5-
> This repository serves v0.117-0. v1.0-RC1 is for testing only, gets no fixes (those go into
6-
> RC2 or 1.0), has no upgrade path, and isn't in this repository; see
5+
> This repository serves v0.117-0. v1.0-RC2 is for testing only, gets no fixes (those go into
6+
> a later RC or 1.0), has no upgrade path, and isn't in this repository; see
77
> [Try the 1.0 release candidate](https://documentdb.io/docs/getting-started/release-candidate/).
88
99
## Clean-host installer
@@ -16,10 +16,12 @@ sudo sh documentdb-install.sh
1616
```
1717

1818
This installs v0.117-0 from this repository on PostgreSQL 18; add `--pg-major 17`
19-
for 17. To try RC1, add `--version v1.0-RC1`, or use the `pgNN-1.0-rc1` container image. The installer then
20-
downloads this host's packages from the
21-
[v1.0-RC1 release](https://github.com/documentdb/documentdb/releases/tag/v1.0-RC1),
22-
verifies them against its `SHA256SUMS`, and doesn't use this repository. See the
19+
for 17. To try RC2, add `--version v1.0-RC2`. The installer then downloads this host's
20+
packages from the
21+
[v1.0-RC2 release](https://github.com/documentdb/documentdb/releases/tag/v1.0-RC2),
22+
verifies them against its `SHA256SUMS`, and doesn't use this repository. The
23+
`pgNN-1.0-rc2` container image also runs RC2; it sends anonymous usage telemetry by default
24+
(opt out with `-e DOCUMENTDB_USAGE_TELEMETRY=false`). See the
2325
[RC guide](https://documentdb.io/docs/getting-started/release-candidate/).
2426

2527
The site serves the `install.sh` attached to the release named in

‎app/services/articleService.ts‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ The current official release publishes the full stack — extension, gateway, se
191191
> Need another distribution or PostgreSQL major? We welcome community builds. Check out the matching release tag and use the version-parameterized [packaging scripts](https://github.com/documentdb/documentdb/blob/v0.117-0/packaging/README.md). \`build_packages.sh\` builds the extension, \`gateway/build_gateway_packages.sh\` builds the gateway, and \`build_extra_packages.sh\` builds the common, tools, stand-alone, and meta packages. PostgreSQL 15 is extension-only because the setup tools require PostgreSQL 16 or newer. These builds are on demand and are not official release assets hosted by documentdb.io.
192192
193193
> [!NOTE]
194-
> Want to try DocumentDB 1.0? [v1.0-RC1](/docs/getting-started/release-candidate) is for testing only, gets no fixes (those go into RC2 or 1.0) and has no upgrade path. It isn't in the package repository, so the commands below install v0.117-0.
194+
> Want to try DocumentDB 1.0? [v1.0-RC2](/docs/getting-started/release-candidate) is for testing only, gets no fixes (those go into a later RC or 1.0) and has no upgrade path. It isn't in the package repository, so the commands below install v0.117-0.
195195
196196
You do not need PostgreSQL already installed — the setup wizard creates and manages its own instance. The install does add the PGDG repository and pull PostgreSQL, PostGIS and around 160 packages (about 140 MB), so pick a host you are willing to have PGDG on.
197197
@@ -205,9 +205,10 @@ sudo sh documentdb-install.sh
205205
\`\`\`
206206
207207
This installs v0.117-0 from the package repository on PostgreSQL 18; add \`--pg-major 17\` for 17.
208-
To try RC1, run \`sudo sh documentdb-install.sh --version v1.0-RC1\` instead, or use the \`pgNN-1.0-rc1\` container image.
209-
It downloads this host's packages from the [v1.0-RC1 release](https://github.com/documentdb/documentdb/releases/tag/v1.0-RC1), verifies them against its \`SHA256SUMS\` and doesn't use the package repository. See the [RC guide](/docs/getting-started/release-candidate).
210-
RC1 gets no fixes and has no upgrade path, so use a clean host.
208+
To try RC2, run \`sudo sh documentdb-install.sh --version v1.0-RC2\` instead.
209+
It downloads this host's packages from the [v1.0-RC2 release](https://github.com/documentdb/documentdb/releases/tag/v1.0-RC2), verifies them against its \`SHA256SUMS\` and doesn't use the package repository.
210+
The \`pgNN-1.0-rc2\` container image also runs RC2; it sends anonymous usage telemetry by default (opt out with \`-e DOCUMENTDB_USAGE_TELEMETRY=false\`). See the [RC guide](/docs/getting-started/release-candidate).
211+
RC2 gets no fixes and has no upgrade path, so use a clean host.
211212
212213
## Install
213214
@@ -1258,7 +1259,7 @@ The \`latest\` tag is a convenience alias. Pin an explicit tag for anything repr
12581259
| \`ghcr.io/documentdb/documentdb/documentdb-local:pg18-0.117.0\` | DocumentDB 0.117.0 on PostgreSQL 18 |
12591260
| \`…:pg17-0.117.0\` | DocumentDB 0.117.0 on PostgreSQL 17 |
12601261
| \`…:pg16-0.117.0\` · \`…:pg15-0.117.0\` | PostgreSQL 16 and 15 |
1261-
| \`…:pg15-1.0-rc1\` · \`…:pg16-1.0-rc1\` · \`…:pg17-1.0-rc1\` · \`…:pg18-1.0-rc1\` | [v1.0-RC1](https://github.com/documentdb/documentdb/releases/tag/v1.0-RC1), for testing only, with [no fixes to RC1 and no upgrade path](/docs/getting-started/release-candidate). No date for 1.0 yet. Use a new, empty data volume. |
1262+
| \`…:pg15-1.0-rc2\` · \`…:pg16-1.0-rc2\` · \`…:pg17-1.0-rc2\` · \`…:pg18-1.0-rc2\` | [v1.0-RC2](https://github.com/documentdb/documentdb/releases/tag/v1.0-RC2), for testing only, with [no fixes to RC2 and no upgrade path](/docs/getting-started/release-candidate). No date for 1.0 yet. Use a new, empty data volume. Sends anonymous usage telemetry by default; see the [privacy statement](https://github.com/documentdb/documentdb/blob/v1.0-RC2/documentdb-local/PRIVACY.md) to opt out. |
12621263
| \`…:latest\` | Currently identical to \`pg17-0.117.0\` |
12631264
12641265
> \`latest\` tracks **PostgreSQL 17**, while the \`documentdb\` package on Linux pins

‎blogs/_posts/2026-10-01-versioning.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ These experimental versions are not intended for long-term use, nor will they be
2727

2828
### Release candidate installation
2929

30+
> **Update:** [v1.0-RC2](https://github.com/documentdb/documentdb/releases/tag/v1.0-RC2) replaces RC1 for testing. Use `rc2` and `v1.0-RC2` in place of `rc1` and `v1.0-RC1` below. The RC2 image sends anonymous usage telemetry by default; add `-e DOCUMENTDB_USAGE_TELEMETRY=false` to opt out.
31+
3032
With Docker:
3133

3234
```bash

‎scripts/publish-installer.mjs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ import { mkdir, writeFile } from 'node:fs/promises';
33
import { resolve } from 'node:path';
44
import { pathToFileURL } from 'node:url';
55

6-
// v0.117-0 ships no installer; RC1's installs from the stable repository.
6+
// v0.117-0 ships no installer; RC2's installs from the stable repository.
77
// Release assets can be replaced, so the digest is pinned too.
88
export const installerSource = {
9-
release: 'v1.0-RC1',
10-
sha256: 'dfacd0cd85ad23de191dee9d39b8fc5b4abe9cf1da7db75ea539ad487a2e9f34',
9+
release: 'v1.0-RC2',
10+
sha256: 'b9d16b3b86d3b1541e701be0ce38086dcb0bc904f761a36c7ede9fefe91d45f2',
1111
};
1212

1313
export async function publishInstaller(outputDirectory = 'out') {

‎tests/packageArticles.test.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -283,11 +283,12 @@ describe('Linux package articles', () => {
283283
expect(new Set(tags)).toEqual(new Set([FALLBACK_RELEASE.tagName]));
284284
});
285285

286-
it('serves the stable installer and selects RC1 only with --version', () => {
286+
it('serves the stable installer and selects RC2 only with --version', () => {
287287
expect(linuxPackagesGuideContent).toContain('https://documentdb.io/install.sh');
288288
expect(linuxPackagesGuideContent).toContain('installs v0.117-0 from the package repository');
289-
expect(linuxPackagesGuideContent).toContain('sh documentdb-install.sh --version v1.0-RC1');
289+
expect(linuxPackagesGuideContent).toContain('sh documentdb-install.sh --version v1.0-RC2');
290290
expect(linuxPackagesGuideContent).toContain("doesn't use the package repository");
291+
expect(linuxPackagesGuideContent).toContain('DOCUMENTDB_USAGE_TELEMETRY=false');
291292
});
292293

293294
it('uses the current release package guide and artifact version', () => {

0 commit comments

Comments
 (0)