- 
                Notifications
    
You must be signed in to change notification settings  - Fork 25.6k
 
[release-notes] Update automation to use new markdown format #124161
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
            
            
          
      
        
          +4,059
        
        
          −1,485
        
        
          
        
      
    
  
Conversation
  
    
      This file contains hidden or 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
    
  
  
    
    …earch into docs-automation-md
… simplify some stuff
…earch into docs-automation-md
| 
           FYI this PR to update headings might be relevant to your templates: #125548  | 
    
…earch into docs-automation-md
…earch into docs-automation-md
| 
           Pinging @elastic/es-docs (Team:Docs)  | 
    
| 
           Pinging @elastic/es-delivery (Team:Delivery)  | 
    
              
                    leemthompo
  
              
              approved these changes
              
                  
                    May 23, 2025 
                  
              
              
            
            
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Output looks good based on 9.0.2 updates. Thanks for all your work on this @brianseeders !
    
  Samiul-TheSoccerFan 
      pushed a commit
        to Samiul-TheSoccerFan/elasticsearch
      that referenced
      this pull request
    
      Jun 5, 2025 
    
    
  
  
    Sign up for free
    to join this conversation on GitHub.
    Already have an account?
    Sign in to comment
  
      Labels
      
    :Delivery/Tooling
  Developer tooliing and automation 
  
    >docs
  General docs changes 
  
    >non-issue
  
    Team:Delivery
  Meta label for Delivery team 
  
    Team:Docs
  Meta label for docs team 
  
    v9.1.0
  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.
  
    
  
    
The release notes for 9.0 are in an entirely new structure compared to 8.x and prior. Not only are the release notes now in markdown, but all release notes now live in
main, instead of on the branch for the given version.So, when we generate the release notes files, we're now generating release notes for all versions at the same time, instead of just one. To make this possible, I'm introducing
ChangelogBundles, which are just yaml files that contain all of the changelogs for a given version, bundled up into one file. That way, we can re-generate all release notes for all versions at any time.My two main goals, outside of supporting the new format/structure were:
Here's what the process now looks like (it's automated, this is just for reference):
Adding missing changelogs or correcting existing ones after a BC is cut is indeed much simpler:
docs/changelog/<PR>.yamlfiledocs/release-notes/changelog-bundles/<version>.ymlfile`./gradlew generateReleaseNotesmain)I have already been using this branch to generate the release notes for 9.0+.
Once this is merged, I will also update the release automation to use it.