Skip to content

[DOCS] Add examples and authorization details for changelog upload#3541

Merged
lcawl merged 2 commits into
mainfrom
changelog-upload-examples
Jun 23, 2026
Merged

[DOCS] Add examples and authorization details for changelog upload#3541
lcawl merged 2 commits into
mainfrom
changelog-upload-examples

Conversation

@lcawl

@lcawl lcawl commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Relates to #3470

This PR augments https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/cli/changelog/upload

AI summary

Created docs/cli/changelog/cmd-upload.md which contains:

  • Description of the command and incremental upload behavior
  • Artifact types table (bundle vs changelog) with default directories
  • Upload targets (s3 vs elasticsearch)
  • S3 bucket structure — object keys and registry.json manifest paths
  • Configuration--directory, --config, and resolution order
  • Four examples matching the style of cmd-bundle-amend.md

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).

Tool(s) and model(s) used: composer-2.5-fast,

@lcawl lcawl requested a review from a team as a code owner June 20, 2026 00:11
@lcawl lcawl added the documentation Improvements or additions to documentation label Jun 20, 2026
@lcawl lcawl requested a review from a team as a code owner June 20, 2026 00:11
@lcawl lcawl requested a review from technige June 20, 2026 00:11
@lcawl lcawl temporarily deployed to integration-tests June 20, 2026 00:11 — with GitHub Actions Inactive
@coderabbitai

coderabbitai Bot commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 36adb137-25dc-435b-a59d-a852bd7689ae

📥 Commits

Reviewing files that changed from the base of the PR and between 654fcce and ed0f29d.

📒 Files selected for processing (1)
  • docs/cli/changelog/cmd-upload.md

📝 Walkthrough

Walkthrough

A new documentation file (docs/cli/changelog/cmd-upload.md) is added, covering the docs-builder changelog upload CLI command. The page describes local artifact discovery (YAML/Bundle), required and optional flags (e.g., --s3-bucket-name), S3 upload behavior with content-hash incremental support, registry refresh semantics, the unimplemented --target elasticsearch path, S3 object key structure, configuration and directory resolution order, and multiple usage examples.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title directly reflects the main change: adding documentation examples and authorization details for the changelog upload command.
Description check ✅ Passed The description is clearly related to the changeset, detailing the new documentation file, its sections, and the purpose of the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch changelog-upload-examples

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@lcawl lcawl requested a review from cotti June 22, 2026 16:57
@lcawl lcawl temporarily deployed to integration-tests June 22, 2026 16:58 — with GitHub Actions Inactive

### Elasticsearch uploads

`--target elasticsearch` has no additional authentication setup today. The target is not yet implemented — the command logs a warning and exits successfully without uploading.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Not important but we will never implement this like this,

We will do a background job syncing S3 to Elasticsearch.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yeah, that makes more sense. I've left as-is for now since that's apparently how it currently functions.

@lcawl lcawl merged commit 2d8a676 into main Jun 23, 2026
25 checks passed
@lcawl lcawl deleted the changelog-upload-examples branch June 23, 2026 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants