github.com/vmware/go-vcloud-director/v2@v2.24.0/.changes/README.md (about)

     1  # Handling of CHANGELOG entries
     2  
     3  ## PR operations
     4  
     5  * All PRs, instead of updating CHANGELOG.md directly, will create individual files in a directory .changes/$version 
     6  * The files will be named `xxx-section_name.md`, where xxx is the PR number, and `section_name` is one of 
     7      * features
     8      * improvements
     9      * bug-fixes
    10      * deprecations
    11      * notes
    12      * removals
    13  
    14  * The changes files must NOT contain the header
    15  
    16  * You can update the file `.changes/sections` to add more headers
    17  * To see the full change set for the current version (or an old one), use `./scripts/make-changelog.sh [version]`
    18  
    19  
    20  ## Post release initialization
    21     
    22  After a release, the changelog will be initialized with the following template:
    23   
    24  ```
    25      ## $VERSION (Unreleased)
    26  
    27      Changes in progress for v$VERSION are available at [.changes/v$VERSION](https://github.com/vmware/go-vcloud-director/tree/main/.changes/v$VERSION) until the release.
    28  ```
    29  
    30  Run `.changes/init.sh version` to get the needed text