Skip to content

Commit 7863549

Browse files
authored
Merge pull request #1075 from planetlabs/release-doc-updates
docs: updating version no longer required for release
2 parents 32e4eee + b368d76 commit 7863549

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

RELEASE.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
Releasing is a two-step process: (1) releasing on GitHub and test.pypi and (2) releasing to PyPI. Releasing on GitHub will automatically trigger a release on test.pypi via a GitHub Action. Following manual confirmation of a successful and satisfactory release on test.pypi, release on PyPI is triggered manually with the Github Action `Autopublish to TestPyPI`. There is also an option to publish to test.pypi and PyPI from your local machine.
66

7+
NOTE: the version is detected from git using the tag name. There is no need to modify a version file.
8+
9+
If the repository is not on tag, the version will be computed using the default versioning scheme of [setuptools_scm](https://setuptools-scm.readthedocs.io/en/latest/usage/#default-versioning-scheme).
710

811
## Versions and Stability
912

@@ -12,7 +15,6 @@ The SDK follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and t
1215
## Release Workflow
1316

1417
1. Create a release branch off of `main` that bumps the SDK version number and updates the changelog:
15-
* Bump SDK version number in `planet/__version__.py`
1618
* Update `CHANGES.txt`, adhering to [keep a changelog](https://keepachangelog.com/)
1719
2. Create a PR for the release branch and merge into `main`
1820
3. Create a new GitHub release:

0 commit comments

Comments
 (0)