Skip to content

Commit fc6f4bc

Browse files
Googlercopybara-github
authored andcommitted
Update Github CHANGELOG for initial release.
PiperOrigin-RevId: 610758474
1 parent e715761 commit fc6f4bc

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CHANGELOG.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Changelog
2+
3+
<!--
4+
5+
Changelog follow the https://keepachangelog.com/ standard (at least the headers)
6+
7+
This allows:
8+
9+
* auto-parsing release notes during the automated releases from github-action:
10+
https://github.com/marketplace/actions/pypi-github-auto-release
11+
* Have clickable headers in the rendered markdown
12+
13+
To release a new version (e.g. from `1.0.0` -> `2.0.0`):
14+
15+
* Create a new `# [0.0.1] - YYYY-MM-DD` header and add the current
16+
`[Unreleased]` notes.
17+
* At the end of the file:
18+
* Define the new link url:
19+
`[0.0.1]: https://github.com/google/cloud_tpu_goodput/compare/v1.0.0...v2.0.0`
20+
* Update the `[Unreleased]` url: `v1.0.0...HEAD` -> `v2.0.0...HEAD`
21+
22+
-->
23+
24+
## [Unreleased]
25+
26+
## [0.0.1] - 2024-02-26
27+
* Initial release of ML Goodput Measurement PyPi package
28+
* Feature: Contains the Goodput module which allows logging and retrieval of training job's overall productive Goodput
29+
30+
[1.0.0]: https://github.com/google/cloud_tpu_goodput/releases/tag/v1.0.0

0 commit comments

Comments
 (0)