Added migration/index.asciidoc generation support #87318
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
craigtaverner
commented
Jun 2, 2022
| @@ -0,0 +1,35 @@ | |||
| [[breaking-changes]] | |||
| = Migration guide | |||
There was a problem hiding this comment.
Perhaps it would make more sense to have this template file contain nothing but the dynamic bits at the bottom, together with an include directive for the main content which should be in the docs section, and not in the template, for easier editing.
craigtaverner
commented
Jun 2, 2022
| @@ -180,6 +180,28 @@ public void getVersions_includesCurrentVersion() { | |||
| ); | |||
| } | |||
|
|
|||
| /** | |||
| * Check that when deriving a lit of major.minor versions from git tags, the current unreleased version is included. | |||
There was a problem hiding this comment.
Spelling of list
There was a problem hiding this comment.
And included should be excluded.
|
Pinging @elastic/es-docs (Team:Docs) |
craigtaverner
force-pushed
the
release-notes-migration-index
branch
from
49a49e8 to
b5d3bb5
Compare
craigtaverner
commented
Jun 2, 2022
| * This class ensures that the migrate/index page has the appropriate anchors and include directives | ||
| * for the current repository version. | ||
| */ | ||
| public class MigrateIndexGenerator { |
There was a problem hiding this comment.
Elsewhere it is migration not migrate so perhaps change name for consistency.
craigtaverner
force-pushed
the
release-notes-migration-index
branch
from
b5d3bb5 to
8ae4c50
Compare
pugnascotia
reviewed
Jun 2, 2022
...nternal/src/main/java/org/elasticsearch/gradle/internal/release/MigrationIndexGenerator.java
Show resolved
Hide resolved
pugnascotia
reviewed
Jun 2, 2022
build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/release/MinorVersion.java
Outdated
Show resolved
Hide resolved
pugnascotia
reviewed
Jun 2, 2022
build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/release/MinorVersion.java
Outdated
Show resolved
Hide resolved
pugnascotia
approved these changes
Jun 2, 2022
…ternal/release/MinorVersion.java Co-authored-by: Rory Hunter <[email protected]>
…ternal/release/MinorVersion.java Co-authored-by: Rory Hunter <[email protected]>
craigtaverner
added a commit
to craigtaverner/elasticsearch
that referenced
this pull request
Jun 2, 2022
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.
craigtaverner
added a commit
that referenced
this pull request
Jun 3, 2022
* 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 (#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 <[email protected]>
craigtaverner
added a commit
to craigtaverner/elasticsearch
that referenced
this pull request
Jun 29, 2022
* 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 <[email protected]>
craigtaverner
added a commit
that referenced
this pull request
Jun 30, 2022
* Generate release notes for v8.3.0 (#87294) * 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 (#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 <[email protected]> * Brought back missing changelog for 87235 (#87370) * Brought back missing changelog for 87235 * Regenerate release notes * Regenerate release notes for BC3 (#87449) * 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 (#87635) * 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 <[email protected]> * Update docs/reference/release-notes/highlights.asciidoc Co-authored-by: David Kilfoyle <[email protected]> * 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 <[email protected]> * Update release notes for BC5 (#87808) * Update release notes for BC6 (#87912) * Update release notes for BC9 (#88011) * Regenerate release notes after version bump 8.4.0 And after forward porting 8.3.0 release notes changes. * Regenerate after some changelog entries removed * Re-prune the changelogs * Removed three changelog entries Co-authored-by: lcawl <[email protected]> Co-authored-by: David Kilfoyle <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When generating release notes for 8.3.0, it was discovered that they could not build due to missing imports in the migration/index.asciidoc file. This was easily added manually in the PR for that release at #87294, but I felt it should have been handled by the gradle task
generateReleaseNotes, so I have added what I think is the right stuff for that.