Skip to content

Commit 65f1094

Browse files
authored
Update the release doc (#97)
Updated the announcement section instead of referring to Airflow release doc since both are a bit different. Also removed the instruction to upload to pypi
1 parent bc16086 commit 65f1094

File tree

1 file changed

+36
-11
lines changed

1 file changed

+36
-11
lines changed

dev/README_RELEASE_CLIENT.md

Lines changed: 36 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -383,22 +383,13 @@ At this point we release an official package:
383383
twine check dist/*
384384
```
385385

386-
- Upload the package to PyPi's test environment:
387-
388-
```shell script
389-
twine upload --repository-url=https://test.pypi.org/legacy/ dist/*
390-
```
391-
392-
- Verify that the test package looks good by downloading it and installing it into a virtual environment.
393-
The package download link is available at: https://test.pypi.org/project/apache-airflow-client/#files
394-
395386
- Upload the package to PyPi's production environment:
396387

397388
```shell script
398389
twine upload -r pypi dist/*
399390
```
400391

401-
- Again, confirm that the package is available here: https://pypi.python.org/pypi/apache-airflow-client
392+
- Confirm that the package is available here: https://pypi.python.org/pypi/apache-airflow-client
402393

403394
- Push Tag for the final version
404395

@@ -413,7 +404,41 @@ Create a new release on GitHub with the release notes and assets from the releas
413404

414405
## Notify developers of release
415406

416-
See Airflow process documented [here](https://github.com/apache/airflow/blob/master/dev/README_RELEASE_AIRFLOW.md#notify-developers-of-release) (just replace Airflow with Airflow Client)
407+
Notify users@airflow.apache.org (cc'ing dev@airflow.apache.org) that the artifacts have been published:
408+
409+
Subject:
410+
411+
```shell script
412+
cat <<EOF
413+
[ANNOUNCE] Apache Airflow Python Client ${VERSION} Released
414+
EOF
415+
```
416+
Body:
417+
418+
```shell script
419+
cat <<EOF
420+
Dear Airflow community,
421+
422+
I'm happy to announce that Airflow Python Client ${VERSION} was just released.
423+
424+
We also made this version available on PyPI for convenience:
425+
`pip install apache-airflow-client`
426+
https://pypi.org/project/apache-airflow-client/${VERSION}/
427+
428+
The documentation is available at:
429+
https://airflow.apache.org/docs/apache-airflow/stable/stable-rest-api-ref.html
430+
431+
Find the changelog here for more details:
432+
https://github.com/apache/airflow-client-python/blob/main/CHANGELOG.md
433+
434+
435+
Cheers,
436+
<your name>
437+
EOF
438+
```
439+
Send the same email to announce@apache.org, except change the opening line to Dear community,. It is more reliable to send it via the web ui at https://lists.apache.org/list.html?announce@apache.org (press "c" to compose a new thread)
440+
441+
417442

418443
## Add release data to Apache Committee Report Helper
419444

0 commit comments

Comments
 (0)