Skip to content

Commit

Permalink
Add changelog template (#6961)
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisdoherty4 authored Nov 3, 2023
1 parent 72246c2 commit 6c56563
Showing 1 changed file with 67 additions and 0 deletions.
67 changes: 67 additions & 0 deletions docs/developer/CHANGELOG_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
## [Version]

<!---
* EACH ENTRY SHOULD BE A SUMMARY OF THE CHANGE; BIG CHANGES GENERALLY REQUIRE MORE EXPLANATION.
* EACH ENTRY SHOULD BE ACCOMPANIED BY EITHER A PUBLIC ISSUE OR A PR (PREFER ISSUES OVER PRS).
* REREAD ALL ENTRIES FROM THE USERS PERSPECTIVE. WILL IT MAKE SENSE?
* IF A SECTION CONTAINS NO ENTRIES, REMOVE THE SECTION.
* IF ALL SECTIONS ARE EMPTY, YOU SHOULDN'T BE DOING A RELEASE!
-->

### Must read before upgrade
<!--
Discuss things a user _really_ needs to know before they upgrade. Its the kind of thing that if unread could
be disasterous.
-->

### Deprecation
<!--
Highlight features, APIs or behavior that we no longer want the user to use/rely on.
-->

### API Change
<!--
Highlight Custom Resource Definition and CLI changes (additions go under Features).
-->

### Feature
<!--
Highlight new additions to Custom Resource Definitions, CLI or any tool we provide for customers.
-->

### Tool Upgrade
<!--
Highlight all upgrades to tooling. Most of this information comes from the build tooling repo. Format as follows.
* Tool Name: <from version> to <to version>
If we support multiple versions format as follows:
* Tool Name:
* <from version> to <to version>
* <from version> to <to version>
* ...
-->

### Bug
<!--
Highlight bug fixes for all applications.
-->

### Other
<!--
Highlight any other changes such as tweaks to behavior.
-->

### Supported Operating Systems
<!--
List all supported OSs for each provider.
-->

| | vSphere | Bare Metal | Nutanix | CloudStack | Snow |
| :----------: | :-----: | :--------: | :-----: | :--------: | :---: |
| Ubuntu 20.04 | βœ” | βœ” | βœ” | β€” | βœ” |
| Ubuntu 22.04 | βœ” | βœ” | βœ” | β€” | β€” |
| Bottlerocket 1.15.1 | βœ” | βœ” | β€” | β€” | β€” |
| RHEL 8.7 | βœ” | βœ” | βœ” | βœ” | β€” |
| RHEL 9.x | β€” | β€” | βœ” | β€” | β€” |

0 comments on commit 6c56563

Please sign in to comment.