You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASE.md
+6-9
Original file line number
Diff line number
Diff line change
@@ -14,23 +14,20 @@ The SDK follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and t
14
14
15
15
## Release Workflow
16
16
17
-
1. Create a release branch off of `main` that bumps the SDK version number and updates the changelog:
18
-
* Update `CHANGES.txt`, adhering to [keep a changelog](https://keepachangelog.com/)
19
-
2. Create a PR for the release branch and merge into `main`
20
-
3. Create a new GitHub release:
17
+
1. Create a new GitHub release:
21
18
* From the GitHub UI:
22
19
* Navigate to the releases UI
23
20
* Set tag to release version
24
21
* Set target to `main`
25
22
* Set title to tag release version
26
-
*Copy description from the new entry in the changelog
23
+
*Describe the change(s) that are shipping with this version in the release description
27
24
* Alternatively, create a release from the GitHub CLI:
28
25
* Make sure the pre-requisite [gh](https://cli.github.com/manual/gh) CLI is installed, and optionally review the docs for CLI command [gh release create](https://cli.github.com/manual/gh_release_create)
29
26
* By default, `gh release create` will automatically tag releases from the latest state of the default branch
30
-
* Run CLI command `gh release create {VERSION} --notes "{RELEASE NOTES}"` where `VERSION` is the release version and `RELEASE NOTES` is the description copied from the new entry in the changelog
31
-
4. Verify the successful run of the Github Action `Autopublish to TestPyPI` and validate the test release on [test.pypi.org](https://test.pypi.org/project/planet/)
32
-
5. Run the Github Action `Publish on PyPI`
33
-
6. Verify the successful run of the Github Action `Publish on PyPI` and validate the release on [pypi.org](https://pypi.org/project/planet/)
27
+
* Run CLI command `gh release create {VERSION} --notes "{RELEASE NOTES}"` where `VERSION` is the release version and `RELEASE NOTES` is the description of changes
28
+
2. Verify the successful run of the Github Action `Autopublish to TestPyPI` and validate the test release on [test.pypi.org](https://test.pypi.org/project/planet/)
29
+
3. Run the Github Action `Publish on PyPI`
30
+
4. Verify the successful run of the Github Action `Publish on PyPI` and validate the release on [pypi.org](https://pypi.org/project/planet/)
0 commit comments