Skip to content

Commit 522c17c

Browse files
committed
Merge branch 'main' into downloading_asset_example-719
2 parents bace35d + 8cca559 commit 522c17c

File tree

3 files changed

+37
-23
lines changed

3 files changed

+37
-23
lines changed

CHANGES.txt

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
2.0a5 (2022-10-20)
2+
3+
- Implement python api data client asset download and supporting functions (#707).
4+
- `planet data filter` cli command outputs a valid empty filter if all
5+
subfilters are removed (#654).
6+
- 'planet orders request' cli command now provides supported bundles for a
7+
given item type, bundle and item type are case-insensitive, and bundle and
8+
item type are moved to positional arguments (#680).
9+
110
2.0a3 (2022-09-07)
211

312
- A change in behavior of httpx affected download of order assets in 2.0a2.
@@ -12,7 +21,7 @@
1221
- Help for planet-subscriptions-describe and update commands has been
1322
corrected, resolving the issue reported in #658.
1423

15-
2.0a2 (2022-07-04)
24+
2.0a2 (2022-08-04)
1625

1726
- Upgrade httpx to 0.23, change how quota exceptions are caught
1827
- Increase reliability of communication with Planet servers and avoid clobbering them

RELEASE.md

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,30 @@
22

33
*Planet maintainers only*
44

5-
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 "Automatically Publish on TestPyPi".
5+
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 "Automatically Publish on TestPyPi". There is also an option to publish to test.pypi and pypi from your local machine.
66

77
#### Release Naming Conventions
88

99
The following are the release naming conventions:
1010

11-
1. Current dev version: Bumped version of last release with `dev` added to the end
11+
1. Current Dev Version is obtained from `planet/__version__.py`
12+
1. Release Version: Remove `dev` from Current Dev Version
13+
1. Next Dev Version: Bumped version of last release with `dev` added to the end.
1214
* **PROPOSAL**: Version number is determined by [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
13-
1. Release version: Remove `dev` from current dev version
1415

15-
Example:
16-
* If
17-
* Previous Release Version == `1.0.0`
18-
* Then
19-
* Current Dev Version: `1.0.1dev`
20-
* Release Version: `1.0.1`
21-
* Next Dev Version: `1.0.2dev`
16+
17+
##### Example:
18+
19+
**IF** Current Dev Version == `1.0.0dev` **THEN**
20+
* Release Version: `1.0.0`
21+
* Next Dev Version: `1.0.1dev`
2222

2323
## Release Workflow
2424

25-
#### Step 1: Release on Github
25+
The release on Github and PyPi performed from a release branch while the release branch PR is in progress. After the releases, the version in the PR is updated before it is merged. Thus, the version in `main` is not the same as the version of the release.
26+
2627
*NOTE: This section refers to version names given in Release Naming Conventions section above.*
28+
2729
1. Create a release branch named `release-{Release Version}`
2830
1. Make the following changes for the release
2931
* Update `CHANGES.txt` (**PROPOSAL**: change this to `docs/CHANGELOG.md`)
@@ -32,21 +34,24 @@ Example:
3234
* Sort according to importance
3335
* **PROPOSAL**: Adhere to [Keep a Changelog](https://keepachangelog.com/)
3436
* Update `planet/__version__.py` to Release Version
35-
1. Create a PR for the release branch (named after release branch), wait for CI to pass
37+
1. Create a PR for the release branch (named after release branch, description is changelog entry), wait for CI to pass
3638
1. Create a new github release:
37-
* Set Tag to the version number specified in `planet/__version__.py`, aka Release Version
39+
* Set Tag Release Version
40+
* **!!!** Set Target to the release branch **!!!**
3841
* Copy Description from the new entry in `docs/CHANGELOG.md`
3942
* Select "This is a pre-release" if applicable
4043
* Select "Create a discussion for this release"
41-
1. Update `planet/__version__.py` to Next Dev Version
42-
1. Merge PR for release branch
43-
44-
###### Step 2: Release on pypi
45-
46-
1. Verify the test release on [test.pypi.org](https://test.pypi.org/project/planet/)
47-
1. Run the Github Action "Publish on PyPi"
44+
1. 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/)
45+
1. Run the Github Action "Publish on PyPi", **!!!** Set Branch to the release branch **!!!**
46+
1. Verify the successful run of the Github Action "Publish on PyPi" and validate the release on [pypi.org](https://pypi.org/project/planet/)
47+
1. Push a commit to the PR updating `planet/__version__.py` to Next Dev Version
48+
1. Merge PR
49+
1. Announce the release through the following avenues:
50+
* *Planet Internal:* #python slack channel
51+
* Changelog
52+
* Twitter
4853

49-
###### Local publishing
54+
### Local publishing
5055

5156
Publishing to testpypi and pypi can also be performed locally with:
5257

planet/__version__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = '2.0a3'
1+
__version__ = '2.0a6dev'

0 commit comments

Comments
 (0)