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
* use the non-deprecated func (#1326)
* 0.8.0 post release steps (#1334)
* add
* fix mkdoc
* Drop upper bounds for fsspec and it's implementations (#1341)
* Drop upper bounds for fsspec and it's implementations
* Run poetry lock
* Ignore tables without `table_type` from Glue and Hive
* Ignore tables without table_type parameters while loading all iceberg table from Glue and Hive catalog (#1331)
* Use TABLE_TYPE
---------
Co-authored-by: Wenzhuo Zhao <[email protected]>
* Replace reference of `Table.identifier` with `Table.name` (#1346)
* fix Table.name
* replace Table.identifier with Table.name
* add warning filter
* Allow leading underscore in column name used in row filter (#1358)
* Update parser.py
Allow leading underscore in column name used in row filter.
* Update test_parser.py
* Update test_parser.py
* Update test_parser.py
* Remove Python 3.13 upper bound restriction (#1355)
* Remove Python 3.13 upper bound restriction
* Fix missing poetry.lock file
* Upgrading numpy on the poetry.lock file from v1.26.0 to v1.26.4
* Improve documentation for "how to release" (#1359)
* initial update
* edits
* add gpg instructions
* verify artifacts
* add twine not
* grammar
* edits
* remove old artifacts
* update doc workflow action
* and name
* add docs on patch vs major/minor release
* fix `KeyError` raised by `add_files` when parquet file doe not have column stats (#1354)
* fix KeyError, by switching del to pop
* added unit test
* update test
* fix python 3.9 compatibility, and refactor test
* update test
* bump to 0.8.1
* Add instruction for patch release (#1373)
* add instruction for patch release
* create branch from tag
* Write `null` when there is no parent-snapshot-id (#1383)
---------
Co-authored-by: Sumanth <[email protected]>
Co-authored-by: gitzwz <[email protected]>
Co-authored-by: Wenzhuo Zhao <[email protected]>
Co-authored-by: vincenzon <[email protected]>
Co-authored-by: Luca Bigon <[email protected]>
Co-authored-by: Binayak Dasgupta <[email protected]>
Co-authored-by: Fokko Driesprong <[email protected]>
This guide outlines the process for releasing PyIceberg in accordance with the [Apache Release Process](https://infra.apache.org/release-publishing.html). The steps include:
23
23
24
-
The first step is to publish a release candidate (RC) and publish it to the public for testing and validation. Once the vote has passed on the RC, the RC turns into the new release.
24
+
1. Preparing for a release
25
+
2. Publishing a Release Candidate (RC)
26
+
3. Community Voting and Validation
27
+
4. Publishing the Final Release (if the vote passes)
28
+
5. Post-Release Step
25
29
26
-
## Preparing for a release
30
+
## Requirements
27
31
28
-
Before running the release candidate, we want to remove any APIs that were marked for removal under the @deprecated tag for this release.
32
+
* A GPG key must be registered and published in the [Apache Iceberg KEYS file](https://downloads.apache.org/iceberg/KEYS). Follow [the instructions for setting up a GPG key and uploading it to the KEYS file](#set-up-gpg-key-and-upload-to-apache-iceberg-keys-file).
33
+
* SVN Access
34
+
* Permission to upload artifacts to the [Apache development distribution](https://dist.apache.org/repos/dist/dev/iceberg/) (requires Apache Commmitter access).
35
+
* Permission to upload artifacts to the [Apache release distribution](https://dist.apache.org/repos/dist/release/iceberg/) (requires Apache PMC access).
36
+
* PyPI Access
37
+
* The `twine` package must be installed for uploading releases to PyPi.
38
+
* A PyPI account with publishing permissions for the [pyiceberg project](https://pypi.org/project/pyiceberg/).
39
+
40
+
## Preparing for a Release
41
+
42
+
### Remove Deprecated APIs
43
+
44
+
Before running the release candidate, we want to remove any APIs that were marked for removal under the `@deprecated` tag for this release. See [#1269](https://github.com/apache/iceberg-python/pull/1269).
29
45
30
46
For example, the API with the following deprecation tag should be removed when preparing for the 0.2.0 release.
31
47
@@ -48,23 +64,49 @@ deprecation_message(
48
64
)
49
65
```
50
66
51
-
## Running a release candidate
67
+
### Update Library Version
68
+
69
+
Update the version in `pyproject.toml` and `pyiceberg/__init__.py` to match the release version. See [#1276](https://github.com/apache/iceberg-python/pull/1276).
70
+
71
+
## Publishing a Release Candidate (RC)
72
+
73
+
### Release Types
74
+
75
+
#### Major/Minor Release
52
76
53
-
Make sure that the version is correct in `pyproject.toml` and `pyiceberg/__init__.py`. Correct means that it reflects the version that you want to release.
77
+
* Use the `main` branch for the release.
78
+
* Includes new features, enhancements, and any necessary backward-compatible changes.
79
+
* Examples: `0.8.0`, `0.9.0`, `1.0.0`.
54
80
55
-
###Setting the tag
81
+
#### Patch Release
56
82
57
-
Make sure that you're on the right branch, and the latest branch:
83
+
* Use the branch corresponding to the patch version, such as `pyiceberg-0.8.x`.
84
+
* Focuses on critical bug fixes or security patches that maintain backward compatibility.
85
+
* Examples: `0.8.1`, `0.8.2`.
58
86
59
-
For a Major/Minor release, make sure that you're on `main`, for patch versions the branch corresponding to the version that you want to patch, i.e. `pyiceberg-0.6.x`.
87
+
To create a patch branch from the latest release tag:
60
88
61
89
```bash
62
-
git checkout <branch>
63
-
git fetch --all
64
-
git reset --hard apache/<branch>
90
+
# Fetch all tags
91
+
git fetch --tags
92
+
93
+
# Assuming 0.8.0 is the latest release tag
94
+
git checkout -b pyiceberg-0.8.x pyiceberg-0.8.0
95
+
96
+
# Cherry-pick commits for the upcoming patch release
97
+
git cherry-pick <commit>
65
98
```
66
99
67
-
Set the tag on the last commit:
100
+
### Create Tag
101
+
102
+
Ensure you are on the correct branch:
103
+
104
+
* For a major/minor release, use the `main` branch
105
+
* For a patch release, use the branch corresponding to the patch version, i.e. `pyiceberg-0.6.x`.
106
+
107
+
Create a signed tag:
108
+
109
+
Replace `VERSION` and `RC` with the appropriate values for the release.
The `-s` option will sign the commit. If you don't have a key yet, you can find the instructions [here](http://www.apache.org/dev/openpgp.html#key-gen-generate-key). To install gpg on a M1 based Mac, a couple of additional steps are required: <https://gist.github.com/phortuin/cf24b1cca3258720c71ad42977e1ba57>.
85
-
If you have not published your GPG key in [KEYS](https://downloads.apache.org/iceberg/KEYS) yet, you must publish it before sending the vote email by doing:
86
-
87
-
```bash
88
-
svn co https://dist.apache.org/repos/dist/release/iceberg icebergsvn
89
-
cd icebergsvn
90
-
echo"">> KEYS # append a newline
91
-
gpg --list-sigs <YOUR KEY ID HERE>>> KEYS # append signatures
92
-
gpg --armor --export <YOUR KEY ID HERE>>> KEYS # append public key block
93
-
svn commit -m "add key for <YOUR NAME HERE>"
94
-
```
122
+
### Publish Release Candidate (RC)
95
123
96
-
### Upload to Apache SVN
124
+
####Upload to Apache Dev SVN
97
125
98
-
Both the source distribution (`sdist`) and the binary distributions (`wheels`) need to be published for the RC. The wheels are convenient to avoid having people to install compilers locally. The downside is that each architecture requires its own wheel. [use `cibuildwheel`](https://github.com/pypa/cibuildwheel) runs in Github actions to create a wheel for each of the architectures.
126
+
##### Create Artifacts for SVN
99
127
100
-
Before committing the files to the Apache SVN artifact distribution SVN hashes need to be generated, and those need to be signed with gpg to make sure that they are authentic.
128
+
Run the [`Python release` Github Action](https://github.com/apache/iceberg-python/actions/workflows/python-release.yml).
101
129
102
-
Go to [Github Actions and run the `Python release` action](https://github.com/apache/iceberg-python/actions/workflows/python-release.yml). **Set the version to main, since we cannot modify the source**.
130
+
* Tag: Use the newly created tag.
131
+
* Version: Set the `version` to `main`, as the source cannot be modified.
103
132
104
133

105
134
106
-
Download the zip, and sign the files:
135
+
This action will generate:
136
+
137
+
* Source distribution (`sdist`)
138
+
* Binary distributions (`wheels`) for each architectures. These are created using [`cibuildwheel`](https://github.com/pypa/cibuildwheel)
139
+
140
+
##### Download Artifacts, Sign, and Generate Checksums
141
+
142
+
Download the ZIP file containing the artifacts from the GitHub Actions run and unzip it.
143
+
144
+
Navigate to the release directory. Sign the files and generate checksums:
145
+
146
+
*`.asc` files: GPG-signed versions of each artifact to ensure authenticity.
147
+
*`.sha512` files: SHA-512 checksums for verifying file integrity.
svn ci -m "PyIceberg ${VERSION}"${SVN_TMP_DIR_VERSIONED}
129
172
```
130
173
131
-
### Upload to PyPi
174
+
Verify the artifact is uploaded to [https://dist.apache.org/repos/dist/dev/iceberg](https://dist.apache.org/repos/dist/dev/iceberg/).
175
+
176
+
##### Remove Old Artifacts From Apache Dev SVN
177
+
178
+
Clean up old RC artifacts:
179
+
180
+
```bash
181
+
svn delete https://dist.apache.org/repos/dist/dev/iceberg/pyiceberg-<OLD_RC_VERSION> -m "Remove old RC artifacts"
182
+
```
183
+
184
+
#### Upload to PyPi
132
185
133
-
Go to Github Actions and run the `Python release` action again. This time, set the **version** of the release candidate as the input: e.g. `0.7.0rc1`. Download the zip and unzip it locally.
186
+
##### Create Artifacts for PyPi
187
+
188
+
Run the [`Python release` Github Action](https://github.com/apache/iceberg-python/actions/workflows/python-release.yml).
189
+
190
+
* Tag: Use the newly created tag.
191
+
* Version: Set the `version` to release candidate, e.g. `0.7.0rc1`.
134
192
135
193

136
194
137
-
Next step is to upload them to pypi. Please keep in mind that this **won't** bump the version for everyone that hasn't pinned their version, since it is set to an RC [pre-release and those are ignored](https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/#pre-release-versioning).
195
+
##### Download Artifacts
196
+
197
+
Download the zip file from the Github Action run and unzip locally.
198
+
199
+
##### Upload Artifacts to PyPi
200
+
201
+
Upload release candidate to PyPi. This **won't** bump the version for everyone that hasn't pinned their version, since it is set to an RC [pre-release and those are ignored](https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/#pre-release-versioning).
202
+
203
+
<!-- prettier-ignore-start -->
204
+
205
+
!!! note
206
+
`twine` might require an PyPi API token.
207
+
208
+
<!-- prettier-ignore-end -->
138
209
139
210
```bash
140
-
twine upload release-0.7.0rc1/*
211
+
twine upload release-${VERSION}/*
141
212
```
142
213
214
+
Verify the artifact is uploaded to [PyPi](https://pypi.org/project/pyiceberg/#history).
215
+
216
+
## Vote
217
+
218
+
### Generate Vote Email
219
+
143
220
Final step is to generate the email to the dev mail list:
144
221
145
222
```bash
223
+
export GIT_TAG_REF=$(git show-ref ${GIT_TAG})
224
+
export GIT_TAG_HASH=${GIT_TAG_REF:0:40}
225
+
export LAST_COMMIT_ID=$(git rev-list ${GIT_TAG}2> /dev/null | head -n 1)
cd /tmp/iceberg-dist-release/pyiceberg-${VERSION_WITHOUT_RC}
235
335
twine upload pyiceberg-*.whl pyiceberg-*.tar.gz
236
336
```
237
337
338
+
Verify the artifact is uploaded to [PyPi](https://pypi.org/project/pyiceberg/#history).
339
+
340
+
## Post Release
341
+
342
+
### Send out Release Announcement Email
343
+
238
344
Send out an announcement on the dev mail list:
239
345
240
346
```text
@@ -253,19 +359,19 @@ This Python release can be downloaded from: https://pypi.org/project/pyiceberg/<
253
359
Thanks to everyone for contributing!
254
360
```
255
361
256
-
## Release the docs
362
+
###Release the docs
257
363
258
-
A committer triggers the [`Python Docs` Github Actions](https://github.com/apache/iceberg-python/actions/workflows/python-ci-docs.yml) through the UI by selecting the branch that just has been released. This will publish the new docs.
364
+
Run the [`Release Docs` Github Action](https://github.com/apache/iceberg-python/actions/workflows/python-release-docs.yml).
259
365
260
-
## Update the Github template
366
+
###Update the Github template
261
367
262
368
Make sure to create a PR to update the [GitHub issues template](https://github.com/apache/iceberg-python/blob/main/.github/ISSUE_TEMPLATE/iceberg_bug_report.yml) with the latest version.
263
369
264
-
## Update the integration tests
370
+
###Update the integration tests
265
371
266
372
Ensure to update the `PYICEBERG_VERSION` in the [Dockerfile](https://github.com/apache/iceberg-python/blob/main/dev/Dockerfile).
267
373
268
-
## Create a Github Release Note
374
+
###Create a Github Release Note
269
375
270
376
Create a [new Release Note](https://github.com/apache/iceberg-python/releases/new) on the iceberg-python Github repository.
271
377
@@ -278,3 +384,22 @@ Then, select the previous release version as the **Previous tag** to use the dif
278
384
**Generate release notes**.
279
385
280
386
**Set as the latest release** and **Publish**.
387
+
388
+
## Misc
389
+
390
+
### Set up GPG key and Upload to Apache Iceberg KEYS file
391
+
392
+
To set up GPG key locally, see the instructions [here](http://www.apache.org/dev/openpgp.html#key-gen-generate-key).
393
+
394
+
To install gpg on a M1 based Mac, a couple of additional steps are required: <https://gist.github.com/phortuin/cf24b1cca3258720c71ad42977e1ba57>.
395
+
396
+
Then, published GPG key to the [Apache Iceberg KEYS file](https://downloads.apache.org/iceberg/KEYS):
397
+
398
+
```bash
399
+
svn co https://dist.apache.org/repos/dist/release/iceberg icebergsvn
400
+
cd icebergsvn
401
+
echo"">> KEYS # append a newline
402
+
gpg --list-sigs <YOUR KEY ID HERE>>> KEYS # append signatures
403
+
gpg --armor --export <YOUR KEY ID HERE>>> KEYS # append public key block
0 commit comments