Add breeze commands for gh workflow docs publish #51036

gopidesupavan · 2025-05-24T23:33:55Z

Adding gh workflow commands, to breeze to trigger workflows.

At present release managers have to do manually running the workflows on multiple repository. to make it easier, we can chain all the steps and run from local.

All the release managers should have already access to trigger workflows from the local.

When running the below command it does following:

Validates given input tag is valid or not
Triggers docs publish workflow in apache/airflow
Waits for the workflow to finish
Triggers workflow in apache/airflow-site repo to refresh the site
Triggers S3 to GitHub sync

eg:
breeze workflow-run publish-docs --ref providers-zendesk/4.7.0 --refresh-site --sync-s3-to-github amazon apache.kafka

See the documentation for more options.

A sample console log from local(Note: i have used my personal repo ;) :

^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in airflow-core/newsfragments.

gopidesupavan · 2025-05-24T23:34:48Z

gopidesupavan · 2025-05-24T23:36:29Z

Still UI option is available to trigger :)

bugraoz93

Looks great! Great addition. Small nit :)

dev/breeze/src/airflow_breeze/utils/gh_workflow_utils.py

Co-authored-by: Bugra Ozturk <bugraoz93@users.noreply.github.com>

gopidesupavan · 2025-05-25T19:18:35Z

@potiuk currently the breeze command has this option --refresh-site --sync-s3-to-github , if it provides then it refreshes and syncs, is this fine or should we default them to always true. ?

github-actions · 2025-05-25T22:23:10Z

Backport failed to create: v3-0-test. View the failure log Run details

Status	Branch	Result
❌	v3-0-test

You can attempt to backport this manually by running:

cherry_picker 7bd29f4 v3-0-test

This should apply the commit to the v3-0-test branch and leave the commit in conflict state marking
the files that need manual conflict resolution.

After you have resolved the conflicts, you can continue the backport process by running:

cherry_picker --continue

* Add breeze commands for gh workflow docs publish * Add breeze commands for gh workflow docs publish * Add sync s3 to github workflow trigger * Update dev/breeze/src/airflow_breeze/utils/gh_workflow_utils.py Co-authored-by: Bugra Ozturk <bugraoz93@users.noreply.github.com> --------- Co-authored-by: Bugra Ozturk <bugraoz93@users.noreply.github.com>

potiuk · 2025-05-29T08:49:23Z

Nice!

potiuk · 2025-05-29T08:55:04Z

@potiuk currently the breeze command has this option --refresh-site --sync-s3-to-github , if it provides then it refreshes and syncs, is this fine or should we default them to always true. ?

I think it would be better to revert it - make it true by default and alo --refresh-site/--no-refresh-site etc. Also we need to make sure to update dev/RELEASE* instructions to include those.. Have it it been also back-ported to v3-0-test @gopidesupavan ? Do you need my help here?

gopidesupavan · 2025-05-31T09:50:01Z

@potiuk currently the breeze command has this option --refresh-site --sync-s3-to-github , if it provides then it refreshes and syncs, is this fine or should we default them to always true. ?

I think it would be better to revert it - make it true by default and alo --refresh-site/--no-refresh-site etc. Also we need to make sure to update dev/RELEASE* instructions to include those.. Have it it been also back-ported to v3-0-test @gopidesupavan ? Do you need my help here?

hard time last few days, agree will check this one today.

gopidesupavan · 2025-05-31T09:50:47Z

We run from main right, thought do we need backport?

potiuk · 2025-05-31T09:52:27Z

hard time last few days, agree will check this one today.

Absolutely no worries Pavan. We all have lives :) . I hppe all is fine.

potiuk · 2025-05-31T09:53:09Z

We run from main right, thought do we need backport?

We will need backport, yes for Airflow docs

* Add breeze commands for gh workflow docs publish * Add breeze commands for gh workflow docs publish * Add sync s3 to github workflow trigger * Update dev/breeze/src/airflow_breeze/utils/gh_workflow_utils.py Co-authored-by: Bugra Ozturk <bugraoz93@users.noreply.github.com> --------- Co-authored-by: Bugra Ozturk <bugraoz93@users.noreply.github.com>

* Add breeze commands for gh workflow docs publish (#51036) * Add breeze commands for gh workflow docs publish * Add breeze commands for gh workflow docs publish * Add sync s3 to github workflow trigger * Update dev/breeze/src/airflow_breeze/utils/gh_workflow_utils.py Co-authored-by: Bugra Ozturk <bugraoz93@users.noreply.github.com> --------- Co-authored-by: Bugra Ozturk <bugraoz93@users.noreply.github.com> * Update GH cli bool inputs to convert to string format in breeze and input branch to refresh site and sync s3 to github (#51093) * Update GH cli bool inputs to convert to string format in breeze * Update branch name to airflow-site-archive trigger * DOCS: Remove site-refresh/sync-s3-to-github and Update release documentation instructions (#51259) * Remove refres sit and sync s3 to github docs args * Update release readme files * Update release readme files --------- Co-authored-by: Bugra Ozturk <bugraoz93@users.noreply.github.com>

gopidesupavan · 2025-06-02T10:34:23Z

hard time last few days, agree will check this one today.

Absolutely no worries Pavan. We all have lives :) . I hppe all is fine.

Yeah all okay :)

* Add breeze commands for gh workflow docs publish (#51036) * Add breeze commands for gh workflow docs publish * Add breeze commands for gh workflow docs publish * Add sync s3 to github workflow trigger * Update dev/breeze/src/airflow_breeze/utils/gh_workflow_utils.py Co-authored-by: Bugra Ozturk <bugraoz93@users.noreply.github.com> --------- Co-authored-by: Bugra Ozturk <bugraoz93@users.noreply.github.com> * Update GH cli bool inputs to convert to string format in breeze and input branch to refresh site and sync s3 to github (#51093) * Update GH cli bool inputs to convert to string format in breeze * Update branch name to airflow-site-archive trigger * DOCS: Remove site-refresh/sync-s3-to-github and Update release documentation instructions (#51259) * Remove refres sit and sync s3 to github docs args * Update release readme files * Update release readme files --------- Co-authored-by: Bugra Ozturk <bugraoz93@users.noreply.github.com>

* Add breeze commands for gh workflow docs publish * Add breeze commands for gh workflow docs publish * Add sync s3 to github workflow trigger * Update dev/breeze/src/airflow_breeze/utils/gh_workflow_utils.py Co-authored-by: Bugra Ozturk <bugraoz93@users.noreply.github.com> --------- Co-authored-by: Bugra Ozturk <bugraoz93@users.noreply.github.com>

gopidesupavan requested review from amoghrajesh, ashb, jedcunningham and potiuk as code owners May 24, 2025 23:33

boring-cyborg bot added the area:dev-tools label May 24, 2025

gopidesupavan requested review from bugraoz93, eladkal, ephraimbuddy, kaxil and shahar1 May 24, 2025 23:35

gopidesupavan added the backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch label May 25, 2025

gopidesupavan requested a review from jscheffl May 25, 2025 10:57

gopidesupavan added 3 commits May 25, 2025 13:51

Add breeze commands for gh workflow docs publish

eec54a0

Add breeze commands for gh workflow docs publish

4c9db1f

Add sync s3 to github workflow trigger

1645280

jscheffl force-pushed the add-breeze-cmd-for-workflows branch from 1b3911a to 1645280 Compare May 25, 2025 11:51

bugraoz93 approved these changes May 25, 2025

View reviewed changes

dev/breeze/src/airflow_breeze/utils/gh_workflow_utils.py Outdated Show resolved Hide resolved

Update dev/breeze/src/airflow_breeze/utils/gh_workflow_utils.py

7e3187f

Co-authored-by: Bugra Ozturk <bugraoz93@users.noreply.github.com>

gopidesupavan mentioned this pull request May 25, 2025

Automatic refresh of airflow-site-archive #50570

Closed

1 task

shahar1 approved these changes May 25, 2025

View reviewed changes

potiuk approved these changes May 25, 2025

View reviewed changes

gopidesupavan merged commit 7bd29f4 into apache:main May 25, 2025
96 checks passed

gopidesupavan deleted the add-breeze-cmd-for-workflows branch May 31, 2025 09:48

Add breeze commands for gh workflow docs publish #51036

Add breeze commands for gh workflow docs publish #51036

Uh oh!

Conversation

gopidesupavan commented May 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gopidesupavan commented May 24, 2025

Uh oh!

gopidesupavan commented May 24, 2025

Uh oh!

bugraoz93 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gopidesupavan commented May 25, 2025

Uh oh!

Uh oh!

github-actions bot commented May 25, 2025

Backport failed to create: v3-0-test. View the failure log Run details

Uh oh!

potiuk commented May 29, 2025

Uh oh!

potiuk commented May 29, 2025

Uh oh!

gopidesupavan commented May 31, 2025

Uh oh!

gopidesupavan commented May 31, 2025

Uh oh!

potiuk commented May 31, 2025

Uh oh!

potiuk commented May 31, 2025

Uh oh!

gopidesupavan commented Jun 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

gopidesupavan commented May 24, 2025 •

edited

Loading