Skip to content

8.4 release notes ported from 8.3.0 release #88136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Jun 30, 2022

Conversation

craigtaverner
Copy link
Contributor

@craigtaverner craigtaverner commented Jun 28, 2022

Forward ported the release notes PRs from 8.3.0 release to the master branch and then regenerated release notes for current 8.4.0 status to check. See generated docs at https://elasticsearch_88136.docs-preview.app.elstc.co/diff

@craigtaverner craigtaverner added >docs General docs changes Team:Docs Meta label for docs team v8.4.0 labels Jun 28, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@debadair
Copy link
Contributor

@elasticmachine retest this please

@debadair
Copy link
Contributor

The conflicts need to be resolved and migrate_8_4.asciidoc is replicating the deprecation from 8.3, which is causing a build failure due to the duplicate ID.

craigtaverner and others added 9 commits June 29, 2022 19:04
* Generate release notes for v8.3.0

* [DOCS] Add 8.3 migration file to index

* Fixed version number

* Fix formatting of deprecation in 85326

* Use asciidoc format for deprecations

* Extract static content from migration/index

* This was just an enhancement

* Nope, it was an upgrade

* Added migration/index.asciidoc generation support (elastic#87318)

Including extracting static content from migration/index, so the template would be as light as possible.

The reason for this work is because the gradle task `generateReleaseNotes` was not correctly adding new links and imports to the migrations/index and that caused documentation to fail building for 8.3.0.

* [DOCS] Add ml-cpp PRs to release notes

* Added back incorrectly deleted changlog

* Added missing highlight

* Fixed spelling of StackOverflowError

Co-authored-by: lcawl <lcawley@elastic.co>
* Brought back missing changelog for 87235

* Regenerate release notes
* Regenerate release notes for BC3

* Re-applied manual fixes that Lisa Cawley used

* Fixed breaking changes generation

To match the manual edits done by Lisa Cawley

* Fixed failing test

Since the manual edits by Lisa removed the `-SNAPSHOT` from the docs
we remove it from the tests too.

* Remove changelogs for intermediate lucene upgrades
* Update release notes for BC4

* Adding missing changelog for geo_grid

* Added missing highlight notes for 84250

* Update docs/reference/release-notes/highlights.asciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>

* Update docs/reference/release-notes/highlights.asciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>

* Backported fixes to original yaml

* Control sort order of release highlights

So that small changes to an individual highlight don't completely shuffle the entire document.

We also added links to the PRs from the highlight titles, for convenience.
Otherwise readers need to search the release notes for the changelog entry and click there,
which is a lot more work.

* Fixed failing test after new ordered highlights

Also made test verify re-ordering of highlights

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
And after forward porting 8.3.0 release notes changes.
@debadair debadair self-requested a review June 29, 2022 17:28
@mark-vieira mark-vieira requested review from pugnascotia and removed request for debadair June 29, 2022 17:28
Copy link
Contributor

@debadair debadair left a comment

Choose a reason for hiding this comment

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

LGTM

@mark-vieira
Copy link
Contributor

@pugnascotia can you take a look here? It's possible our instructions for forward porting release notes might need some improvements. I don't see why we would be adding changelog yaml files to master and @craigtaverner reported that running pruneChangelogs didn't delete the entries he expected.

@craigtaverner craigtaverner merged commit 9080cc8 into elastic:master Jun 30, 2022
@pugnascotia
Copy link
Contributor

@pugnascotia can you take a look here? It's possible our instructions for forward porting release notes might need some improvements. I don't see why we would be adding changelog yaml files to master and @craigtaverner reported that running pruneChangelogs didn't delete the entries he expected.

The docs don't are 100% explicit, but the expectation is that only the asciidoc changes are forward-ported. I can't think of. a reason why we'd every forward-port changelog YAML files. I raised https://github.com/elastic/elasticsearch-team/pull/894.

As for the pruning, that'll be hard to diagnose without being able to replicate it. The logic is that we list all release tags before the release we just did for the current and prior major series, and for each tag find all changelog files at that tag. Then we find the intersection between those files and the files currently on disk. There would be a problem if the latest release tag hadn't appeared yet in the repo, and it's quite possible that it hasn't when the teams are told to execute the version bump. But why you'd end up with a partial prune, I don't know.

@craigtaverner craigtaverner deleted the 8.4-release-notes branch October 20, 2023 11:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes Team:Docs Meta label for docs team v8.4.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants