Skip to content

Commit b1d0893

Browse files
cotticursoragent
andauthored
docs: use singular changelog/bundle S3 key prefixes (#179)
Match the docs-builder change that uploads changelog/bundle artifacts under {product}/changelog/ and {product}/bundle/ instead of the plural prefixes. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent b507b2c commit b1d0893

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

changelog/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ Each PR produces a file at `docs/changelog/{filename}.yaml` on the PR branch (wh
189189

190190
## Uploading to S3
191191

192-
Changelog files on the default branch can be uploaded to S3. Files land in a **private bucket** (`elastic-docs-v3-changelog-bundles-private`), which is the internal source of truth. A scrubber Lambda automatically mirrors sanitized copies (with private repository references removed) to the **public bucket** served via CloudFront CDN. Changelogs are uploaded under `{product}/changelogs/{filename}.yaml`.
192+
Changelog files on the default branch can be uploaded to S3. Files land in a **private bucket** (`elastic-docs-v3-changelog-bundles-private`), which is the internal source of truth. A scrubber Lambda automatically mirrors sanitized copies (with private repository references removed) to the **public bucket** served via CloudFront CDN. Changelogs are uploaded under `{product}/changelog/{filename}.yaml`.
193193

194194
### 1. Add the upload workflow
195195

@@ -431,7 +431,7 @@ If your changelog configuration is not at `docs/changelog.yml`, pass the path ex
431431

432432
### Output
433433

434-
The primary workflow (`changelog-bundle.yml`) uploads the bundle to the `elastic-docs-v3-changelog-bundles` S3 bucket under `{product}/bundles/{filename}`. The bundle is available to downstream rendering workflows immediately after upload.
434+
The primary workflow (`changelog-bundle.yml`) uploads the bundle to the `elastic-docs-v3-changelog-bundles` S3 bucket under `{product}/bundle/{filename}`. The bundle is available to downstream rendering workflows immediately after upload.
435435

436436
### Bundle PR workflow (opt-in)
437437

changelog/bundle-upload/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ steps:
2626
output: docs/releases/v9.2.0.yaml
2727
```
2828
29-
This action is typically used as the second job in the `changelog-bundle.yml` reusable workflow, after `bundle-create` generates the artifact. The S3 key for each bundle is `{product}/bundles/{filename}`, where the product is read from the bundle's YAML `products` array.
29+
This action is typically used as the second job in the `changelog-bundle.yml` reusable workflow, after `bundle-create` generates the artifact. The S3 key for each bundle is `{product}/bundle/{filename}`, where the product is read from the bundle's YAML `products` array.

0 commit comments

Comments
 (0)