Skip to content

Commit 4e14cd1

Browse files
committed
Improve/simplify/remove superfluous flags in release provider process (#36195)
Few small nits in commands used for relase process for providers (cherry picked from commit 4a4913c)
1 parent 64d477f commit 4e14cd1

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

dev/README_RELEASE_PROVIDER_PACKAGES.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -161,9 +161,16 @@ Details about maintaining the SEMVER version are going to be discussed and imple
161161
[the related issue](https://github.com/apache/airflow/issues/11425)
162162

163163
```shell script
164-
breeze release-management prepare-provider-documentation --include-removed-providers [packages]
164+
breeze release-management prepare-provider-documentation --include-removed-providers
165165
```
166166

167+
In case you prepare provider documentation for just a few selected providers, you can run:
168+
169+
```shell script
170+
breeze release-management prepare-provider-documentation [packages]
171+
```
172+
173+
167174
This command will not only prepare documentation but will also help the release manager to review
168175
changes implemented in all providers, and determine which of the providers should be released. For each
169176
provider details will be printed on what changes were implemented since the last release including
@@ -183,7 +190,13 @@ When you want to regenerate the changes before the release and make sure all cha
183190
are updated, run it in non-interactive mode:
184191

185192
```shell script
186-
breeze release-management prepare-provider-documentation --include-removed-providers --answer yes [packages]
193+
breeze release-management prepare-provider-documentation --include-removed-providers --answer yes
194+
```
195+
196+
In case you prepare provider documentation for just a few selected providers, you can run:
197+
198+
```shell script
199+
breeze release-management prepare-provider-documentation --answer yes [packages]
187200
```
188201

189202
NOTE!! In case you prepare provider's documentation in a branch different than main, you need to manually
@@ -320,7 +333,7 @@ breeze release-management prepare-provider-packages --include-removed-providers
320333
if you only build few packages, run:
321334

322335
```shell script
323-
breeze release-management prepare-provider-packages --include-removed-providers \
336+
breeze release-management prepare-provider-packages \
324337
--version-suffix-for-pypi rc1 --package-format both PACKAGE PACKAGE ....
325338
```
326339

@@ -403,7 +416,7 @@ git pull --rebase
403416

404417
```shell script
405418
cd "${AIRFLOW_REPO_ROOT}"
406-
breeze build-docs --clean-build apache-airflow-providers --package-filter 'apache-airflow-providers-*'
419+
breeze build-docs --clean-build apache-airflow-providers all-providers
407420
```
408421

409422
Usually when we release packages we also build documentation for the "documentation-only" packages. This
@@ -442,8 +455,7 @@ way faster on multi-cpu machines when you are publishing multiple providers:
442455
```shell script
443456
cd "${AIRFLOW_REPO_ROOT}"
444457

445-
breeze release-management publish-docs apache-airflow-providers --include-removed-providers \
446-
--package-filter 'apache-airflow-providers-*' \
458+
breeze release-management publish-docs apache-airflow-providers all-providers --include-removed-providers \
447459
--override-versioned --run-in-parallel
448460

449461
breeze release-management add-back-references all-providers
@@ -460,7 +472,7 @@ If you have providers as list of provider ids because you just released them you
460472
```shell script
461473
cd "${AIRFLOW_REPO_ROOT}"
462474

463-
breeze release-management publish-docs --include-removed-providers amazon apache.beam google ....
475+
breeze release-management publish-docs amazon apache.beam google ....
464476
breeze release-management add-back-references all-providers
465477
```
466478

@@ -660,8 +672,7 @@ rm -rf dist/*
660672
4) Build the packages using checked out sources
661673

662674
```shell
663-
breeze release-management prepare-provider-packages --include-removed-providers \
664-
--package-format both --include-removed-providers
675+
breeze release-management prepare-provider-packages --include-removed-providers --package-format both
665676
```
666677

667678
5) Switch to the folder where you checked out the SVN dev files

0 commit comments

Comments
 (0)