Skip to content

Commit fc45fd8

Browse files
Update Release Docs and flake8 Ignore Rules (#1108)
* update release docs * add f824 to flake8 ignore
1 parent 4374ec8 commit fc45fd8

File tree

2 files changed

+7
-10
lines changed

2 files changed

+7
-10
lines changed

RELEASE.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,20 @@ The SDK follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and t
1414

1515
## Release Workflow
1616

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:
2118
* From the GitHub UI:
2219
* Navigate to the releases UI
2320
* Set tag to release version
2421
* Set target to `main`
2522
* 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
2724
* Alternatively, create a release from the GitHub CLI:
2825
* 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)
2926
* 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/)
3431

3532

3633
## Local publishing

setup.cfg

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ split_all_top_level_comma_separated_values=true
2626
allow_split_before_dict_value=false
2727

2828
[flake8]
29-
ignore = E121,E126,E501,W50
29+
ignore = E121,E126,E501,W50,F824

0 commit comments

Comments
 (0)