elastic / elastic/docs-builder

Enhance changelog upload with option to prevent overwrites

Open
#4,071 1 comment 0 reactions 0 assignees View on GitHub
enhancement needs triage
Dominant language
C#
Stars
24
Forks
44
Avg merge
1d 7h
Merged PRs (30d)
146

Description

### What is getting in your way?

When I run the `docs-builder changelog upload` command, if a file already exists in S3 but I've made changes to it locally, the local copy is always pushed to S3.
This model assumes that what is local is always better, but at this moment that's not always true.

### What would you like instead?

I would like a `--no-overwrite` (or similar) option so that the command forces me to reconcile the differences.

Right now the use case is that I've created a changelog with `cloud-serverless` as its product but then it gets shipped in `elasticsearch` too. I want to ensure that I get a chance to look at the content (and verify that the products are set appropriately if nothing else), edit my local file, then re-run it without the "--no-overwrite" so that the manully-consolidated and verified file gets pushed.

### Anything else?

TBD whether this is still useful when we get to the point that changelogs are all being created automatically at PR time and uploaded automatically. I think in this case it might still be useful to know when it's overwriting existing files, so maybe just including that information in the command output is still useful, though there will be less expectation of human intervention.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.