Skip to content

[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255)#57257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
potiuk merged 1 commit into from
Oct 25, 2025
Merged

[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255) #57257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 53 additions & 12 deletions dev/README_RELEASE_HELM_CHART.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -733,31 +733,72 @@ you need to run several workflows to publish the documentation. More details abo
[Docs README](../docs/README.md) showing the architecture and workflows including manual workflows for
emergency cases.

There are two steps to publish the documentation:
There are two ways to publish the documentation - using breeze command from your local machine or
using breeze commands from GitHub Actions. Both are actually execute remote workflows in GitHub Actions.

1. Publish the documentation to the `live` S3 bucket.
### Using breeze commands

The release manager publishes the documentation using GitHub Actions workflow
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml).
You can use the `breeze` command to publish the documentation.
The command does the following:

1. Triggers [Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml).
2. Triggers workflow in apache/airflow-site to refresh
3. Triggers S3 to GitHub Sync

```shell script
breeze workflow-run publish-docs --ref <tag> --site-env <staging/live/auto> helm-chart
```

The `--ref` parameter should be the tag of the release candidate you are publishing. This should be a
release tag like `helm-chart/1.1.0`

The `--site-env` parameter should be set to `staging` for pre-release versions or `live` for final releases.
The default option is `auto` which should automatically select the right environment based on the tag name.

Other available parameters can be found with:

```shell script
breeze workflow-run publish-docs --help
```

You should specify the tag to use to build the docs and 'helm-chart' passed as packages to be built.
One of the interesting features of publishing this way is that you can also rebuild historical version of
the documentation with patches applied to the documentation (if they can be applied cleanly).

Yoy should specify the `--apply-commits` parameter with the list of commits you want to apply
separated by commas and the workflow will apply those commits to the documentation before
building it. (don't forget to add --skip-write-to-stable-folder if you are publishing
previous version of the distribution). Example:

```shell script
breeze workflow-run publish-docs --ref helm-chart/1.18.0 --site-env staging \
--apply-commits 4ae273cbedec66c87dc40218c7a94863390a380d,e61e9618bdd6be8213d277b1427f67079fcb1d9b \
--skip-write-to-stable-folder \
helm-chart
```

### Manually using GitHub Actions

There are two steps to publish the documentation:

1. Publish the documentation to the `staging` S3 bucket.

The release manager publishes the documentation using GitHub Actions workflow
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml). By default
`auto` selection should publish to the `live` bucket - based on
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml). By default `auto` selection should publish to the `staging` bucket - based on
the tag you use - pre-release tags go to staging. But you can also override it and specify the destination
manually to be `live` or `staging`.

After that step, the provider documentation should be available under the https://airflow.apache.org
(same as in the helm chart documentation).
You should specify 'helm-chart' passed as packages to be built.

After that step, the provider documentation should be available under https://airflow.stage.apache.org//
URL (RC PyPI packages are build with the staging urls) but stable links and drop-down boxes are not updated yet.

2. Invalidated Fastly cache for the documentation.
2. Invalidate Fastly cache, update version drop-down and stable links with the new versions of the documentation.

In order to do it, you need to run the [Build docs](https://github.com/apache/airflow-site/actions/workflows/build.yml)
workflow in `airflow-site` repository. Make sure to use `main` branch.
workflow in `airflow-site` repository - but make sure to use `staging` branch.

After that workflow completes, the new version should be available in the drop-down list and stable links
should be updated and Fastly cache should be invalidated.
should be updated, also Fastly cache will be updated

## Update `index.yaml` in airflow-site

Expand Down
1 change: 1 addition & 0 deletions dev/breeze/src/airflow_breeze/commands/workflow_commands.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,7 @@ def workflow_run_publish(
get_console().print(
f"[red]Error: Ref {ref} does not exists in repo apache/airflow .[/red]",
)
get_console().print("\nYou can add --skip-tag-validation to skip this validation.")
sys.exit(1)

get_console().print(
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255) by github-actions[bot] · Pull Request #57257 · apache/airflow · GitHub
Skip to content
[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255)#57257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

potiuk
merged 1 commit into

from

Oct 25, 2025
 Merged


[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255)
#57257
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


65 changes: 53 additions & 12 deletions
dev/README_RELEASE_HELM_CHART.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -733,31 +733,72 @@ you need to run several workflows to publish the documentation. More details abo
[Docs README](../docs/README.md) showing the architecture and workflows including manual workflows for
emergency cases.

There are two steps to publish the documentation:
There are two ways to publish the documentation - using breeze command from your local machine or
using breeze commands from GitHub Actions. Both are actually execute remote workflows in GitHub Actions.

1. Publish the documentation to the `live` S3 bucket.
### Using breeze commands

The release manager publishes the documentation using GitHub Actions workflow
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml).
You can use the `breeze` command to publish the documentation.
The command does the following:

1. Triggers [Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml).
2. Triggers workflow in apache/airflow-site to refresh
3. Triggers S3 to GitHub Sync

```shell script
breeze workflow-run publish-docs --ref <tag> --site-env <staging/live/auto> helm-chart
```

The `--ref` parameter should be the tag of the release candidate you are publishing. This should be a
release tag like `helm-chart/1.1.0`

The `--site-env` parameter should be set to `staging` for pre-release versions or `live` for final releases.
The default option is `auto` which should automatically select the right environment based on the tag name.

Other available parameters can be found with:

```shell script
breeze workflow-run publish-docs --help
```

You should specify the tag to use to build the docs and 'helm-chart' passed as packages to be built.
One of the interesting features of publishing this way is that you can also rebuild historical version of
the documentation with patches applied to the documentation (if they can be applied cleanly).

Yoy should specify the `--apply-commits` parameter with the list of commits you want to apply
separated by commas and the workflow will apply those commits to the documentation before
building it. (don't forget to add --skip-write-to-stable-folder if you are publishing
previous version of the distribution). Example:

```shell script
breeze workflow-run publish-docs --ref helm-chart/1.18.0 --site-env staging \
 --apply-commits 4ae273cbedec66c87dc40218c7a94863390a380d,e61e9618bdd6be8213d277b1427f67079fcb1d9b \
 --skip-write-to-stable-folder \
 helm-chart
```

### Manually using GitHub Actions

There are two steps to publish the documentation:

1. Publish the documentation to the `staging` S3 bucket.

The release manager publishes the documentation using GitHub Actions workflow
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml). By default
`auto` selection should publish to the `live` bucket - based on
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml). By default `auto` selection should publish to the `staging` bucket - based on
the tag you use - pre-release tags go to staging. But you can also override it and specify the destination
manually to be `live` or `staging`.

After that step, the provider documentation should be available under the https://airflow.apache.org
(same as in the helm chart documentation).
You should specify 'helm-chart' passed as packages to be built.

After that step, the provider documentation should be available under https://airflow.stage.apache.org//
URL (RC PyPI packages are build with the staging urls) but stable links and drop-down boxes are not updated yet.

2. Invalidated Fastly cache for the documentation.
2. Invalidate Fastly cache, update version drop-down and stable links with the new versions of the documentation.

In order to do it, you need to run the [Build docs](https://github.com/apache/airflow-site/actions/workflows/build.yml)
workflow in `airflow-site` repository. Make sure to use `main` branch.
workflow in `airflow-site` repository - but make sure to use `staging` branch.

After that workflow completes, the new version should be available in the drop-down list and stable links
should be updated and Fastly cache should be invalidated.
should be updated, also Fastly cache will be updated

## Update `index.yaml` in airflow-site

Expand Down

1 change: 1 addition & 0 deletions
dev/breeze/src/airflow_breeze/commands/workflow_commands.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,7 @@ def workflow_run_publish(
 get_console().print(
 f"[red]Error: Ref {ref} does not exists in repo apache/airflow .[/red]",
 )
 get_console().print("\nYou can add --skip-tag-validation to skip this validation.")
 sys.exit(1)

 get_console().print(
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255) by github-actions[bot] · Pull Request #57257 · apache/airflow · GitHub
Skip to content
[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255)#57257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

potiuk
merged 1 commit into

from

Oct 25, 2025
 Merged


[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255)
#57257
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


65 changes: 53 additions & 12 deletions
dev/README_RELEASE_HELM_CHART.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -733,31 +733,72 @@ you need to run several workflows to publish the documentation. More details abo
[Docs README](../docs/README.md) showing the architecture and workflows including manual workflows for
emergency cases.

There are two steps to publish the documentation:
There are two ways to publish the documentation - using breeze command from your local machine or
using breeze commands from GitHub Actions. Both are actually execute remote workflows in GitHub Actions.

1. Publish the documentation to the `live` S3 bucket.
### Using breeze commands

The release manager publishes the documentation using GitHub Actions workflow
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml).
You can use the `breeze` command to publish the documentation.
The command does the following:

1. Triggers [Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml).
2. Triggers workflow in apache/airflow-site to refresh
3. Triggers S3 to GitHub Sync

```shell script
breeze workflow-run publish-docs --ref <tag> --site-env <staging/live/auto> helm-chart
```

The `--ref` parameter should be the tag of the release candidate you are publishing. This should be a
release tag like `helm-chart/1.1.0`

The `--site-env` parameter should be set to `staging` for pre-release versions or `live` for final releases.
The default option is `auto` which should automatically select the right environment based on the tag name.

Other available parameters can be found with:

```shell script
breeze workflow-run publish-docs --help
```

You should specify the tag to use to build the docs and 'helm-chart' passed as packages to be built.
One of the interesting features of publishing this way is that you can also rebuild historical version of
the documentation with patches applied to the documentation (if they can be applied cleanly).

Yoy should specify the `--apply-commits` parameter with the list of commits you want to apply
separated by commas and the workflow will apply those commits to the documentation before
building it. (don't forget to add --skip-write-to-stable-folder if you are publishing
previous version of the distribution). Example:

```shell script
breeze workflow-run publish-docs --ref helm-chart/1.18.0 --site-env staging \
 --apply-commits 4ae273cbedec66c87dc40218c7a94863390a380d,e61e9618bdd6be8213d277b1427f67079fcb1d9b \
 --skip-write-to-stable-folder \
 helm-chart
```

### Manually using GitHub Actions

There are two steps to publish the documentation:

1. Publish the documentation to the `staging` S3 bucket.

The release manager publishes the documentation using GitHub Actions workflow
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml). By default
`auto` selection should publish to the `live` bucket - based on
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml). By default `auto` selection should publish to the `staging` bucket - based on
the tag you use - pre-release tags go to staging. But you can also override it and specify the destination
manually to be `live` or `staging`.

After that step, the provider documentation should be available under the https://airflow.apache.org
(same as in the helm chart documentation).
You should specify 'helm-chart' passed as packages to be built.

After that step, the provider documentation should be available under https://airflow.stage.apache.org//
URL (RC PyPI packages are build with the staging urls) but stable links and drop-down boxes are not updated yet.

2. Invalidated Fastly cache for the documentation.
2. Invalidate Fastly cache, update version drop-down and stable links with the new versions of the documentation.

In order to do it, you need to run the [Build docs](https://github.com/apache/airflow-site/actions/workflows/build.yml)
workflow in `airflow-site` repository. Make sure to use `main` branch.
workflow in `airflow-site` repository - but make sure to use `staging` branch.

After that workflow completes, the new version should be available in the drop-down list and stable links
should be updated and Fastly cache should be invalidated.
should be updated, also Fastly cache will be updated

## Update `index.yaml` in airflow-site

Expand Down

1 change: 1 addition & 0 deletions
dev/breeze/src/airflow_breeze/commands/workflow_commands.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,7 @@ def workflow_run_publish(
 get_console().print(
 f"[red]Error: Ref {ref} does not exists in repo apache/airflow .[/red]",
 )
 get_console().print("\nYou can add --skip-tag-validation to skip this validation.")
 sys.exit(1)

 get_console().print(
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255) by github-actions[bot] · Pull Request #57257 · apache/airflow · GitHub
Skip to content
[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255)#57257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

potiuk
merged 1 commit into

from

Oct 25, 2025
 Merged


[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255)
#57257
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


65 changes: 53 additions & 12 deletions
dev/README_RELEASE_HELM_CHART.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -733,31 +733,72 @@ you need to run several workflows to publish the documentation. More details abo
[Docs README](../docs/README.md) showing the architecture and workflows including manual workflows for
emergency cases.

There are two steps to publish the documentation:
There are two ways to publish the documentation - using breeze command from your local machine or
using breeze commands from GitHub Actions. Both are actually execute remote workflows in GitHub Actions.

1. Publish the documentation to the `live` S3 bucket.
### Using breeze commands

The release manager publishes the documentation using GitHub Actions workflow
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml).
You can use the `breeze` command to publish the documentation.
The command does the following:

1. Triggers [Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml).
2. Triggers workflow in apache/airflow-site to refresh
3. Triggers S3 to GitHub Sync

```shell script
breeze workflow-run publish-docs --ref <tag> --site-env <staging/live/auto> helm-chart
```

The `--ref` parameter should be the tag of the release candidate you are publishing. This should be a
release tag like `helm-chart/1.1.0`

The `--site-env` parameter should be set to `staging` for pre-release versions or `live` for final releases.
The default option is `auto` which should automatically select the right environment based on the tag name.

Other available parameters can be found with:

```shell script
breeze workflow-run publish-docs --help
```

You should specify the tag to use to build the docs and 'helm-chart' passed as packages to be built.
One of the interesting features of publishing this way is that you can also rebuild historical version of
the documentation with patches applied to the documentation (if they can be applied cleanly).

Yoy should specify the `--apply-commits` parameter with the list of commits you want to apply
separated by commas and the workflow will apply those commits to the documentation before
building it. (don't forget to add --skip-write-to-stable-folder if you are publishing
previous version of the distribution). Example:

```shell script
breeze workflow-run publish-docs --ref helm-chart/1.18.0 --site-env staging \
 --apply-commits 4ae273cbedec66c87dc40218c7a94863390a380d,e61e9618bdd6be8213d277b1427f67079fcb1d9b \
 --skip-write-to-stable-folder \
 helm-chart
```

### Manually using GitHub Actions

There are two steps to publish the documentation:

1. Publish the documentation to the `staging` S3 bucket.

The release manager publishes the documentation using GitHub Actions workflow
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml). By default
`auto` selection should publish to the `live` bucket - based on
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml). By default `auto` selection should publish to the `staging` bucket - based on
the tag you use - pre-release tags go to staging. But you can also override it and specify the destination
manually to be `live` or `staging`.

After that step, the provider documentation should be available under the https://airflow.apache.org
(same as in the helm chart documentation).
You should specify 'helm-chart' passed as packages to be built.

After that step, the provider documentation should be available under https://airflow.stage.apache.org//
URL (RC PyPI packages are build with the staging urls) but stable links and drop-down boxes are not updated yet.

2. Invalidated Fastly cache for the documentation.
2. Invalidate Fastly cache, update version drop-down and stable links with the new versions of the documentation.

In order to do it, you need to run the [Build docs](https://github.com/apache/airflow-site/actions/workflows/build.yml)
workflow in `airflow-site` repository. Make sure to use `main` branch.
workflow in `airflow-site` repository - but make sure to use `staging` branch.

After that workflow completes, the new version should be available in the drop-down list and stable links
should be updated and Fastly cache should be invalidated.
should be updated, also Fastly cache will be updated

## Update `index.yaml` in airflow-site

Expand Down

1 change: 1 addition & 0 deletions
dev/breeze/src/airflow_breeze/commands/workflow_commands.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,7 @@ def workflow_run_publish(
 get_console().print(
 f"[red]Error: Ref {ref} does not exists in repo apache/airflow .[/red]",
 )
 get_console().print("\nYou can add --skip-tag-validation to skip this validation.")
 sys.exit(1)

 get_console().print(
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255) by github-actions[bot] · Pull Request #57257 · apache/airflow · GitHub
Skip to content
[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255)#57257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

potiuk
merged 1 commit into

from

Oct 25, 2025
 Merged


[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255)
#57257
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


65 changes: 53 additions & 12 deletions
dev/README_RELEASE_HELM_CHART.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -733,31 +733,72 @@ you need to run several workflows to publish the documentation. More details abo
[Docs README](../docs/README.md) showing the architecture and workflows including manual workflows for
emergency cases.

There are two steps to publish the documentation:
There are two ways to publish the documentation - using breeze command from your local machine or
using breeze commands from GitHub Actions. Both are actually execute remote workflows in GitHub Actions.

1. Publish the documentation to the `live` S3 bucket.
### Using breeze commands

The release manager publishes the documentation using GitHub Actions workflow
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml).
You can use the `breeze` command to publish the documentation.
The command does the following:

1. Triggers [Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml).
2. Triggers workflow in apache/airflow-site to refresh
3. Triggers S3 to GitHub Sync

```shell script
breeze workflow-run publish-docs --ref <tag> --site-env <staging/live/auto> helm-chart
```

The `--ref` parameter should be the tag of the release candidate you are publishing. This should be a
release tag like `helm-chart/1.1.0`

The `--site-env` parameter should be set to `staging` for pre-release versions or `live` for final releases.
The default option is `auto` which should automatically select the right environment based on the tag name.

Other available parameters can be found with:

```shell script
breeze workflow-run publish-docs --help
```

You should specify the tag to use to build the docs and 'helm-chart' passed as packages to be built.
One of the interesting features of publishing this way is that you can also rebuild historical version of
the documentation with patches applied to the documentation (if they can be applied cleanly).

Yoy should specify the `--apply-commits` parameter with the list of commits you want to apply
separated by commas and the workflow will apply those commits to the documentation before
building it. (don't forget to add --skip-write-to-stable-folder if you are publishing
previous version of the distribution). Example:

```shell script
breeze workflow-run publish-docs --ref helm-chart/1.18.0 --site-env staging \
 --apply-commits 4ae273cbedec66c87dc40218c7a94863390a380d,e61e9618bdd6be8213d277b1427f67079fcb1d9b \
 --skip-write-to-stable-folder \
 helm-chart
```

### Manually using GitHub Actions

There are two steps to publish the documentation:

1. Publish the documentation to the `staging` S3 bucket.

The release manager publishes the documentation using GitHub Actions workflow
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml). By default
`auto` selection should publish to the `live` bucket - based on
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml). By default `auto` selection should publish to the `staging` bucket - based on
the tag you use - pre-release tags go to staging. But you can also override it and specify the destination
manually to be `live` or `staging`.

After that step, the provider documentation should be available under the https://airflow.apache.org
(same as in the helm chart documentation).
You should specify 'helm-chart' passed as packages to be built.

After that step, the provider documentation should be available under https://airflow.stage.apache.org//
URL (RC PyPI packages are build with the staging urls) but stable links and drop-down boxes are not updated yet.

2. Invalidated Fastly cache for the documentation.
2. Invalidate Fastly cache, update version drop-down and stable links with the new versions of the documentation.

In order to do it, you need to run the [Build docs](https://github.com/apache/airflow-site/actions/workflows/build.yml)
workflow in `airflow-site` repository. Make sure to use `main` branch.
workflow in `airflow-site` repository - but make sure to use `staging` branch.

After that workflow completes, the new version should be available in the drop-down list and stable links
should be updated and Fastly cache should be invalidated.
should be updated, also Fastly cache will be updated

## Update `index.yaml` in airflow-site

Expand Down

1 change: 1 addition & 0 deletions
dev/breeze/src/airflow_breeze/commands/workflow_commands.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,7 @@ def workflow_run_publish(
 get_console().print(
 f"[red]Error: Ref {ref} does not exists in repo apache/airflow .[/red]",
 )
 get_console().print("\nYou can add --skip-tag-validation to skip this validation.")
 sys.exit(1)

 get_console().print(
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255) by github-actions[bot] · Pull Request #57257 · apache/airflow · GitHub
Skip to content
[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255)#57257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

potiuk
merged 1 commit into

from

Oct 25, 2025
 Merged


[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255)
#57257
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


65 changes: 53 additions & 12 deletions
dev/README_RELEASE_HELM_CHART.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -733,31 +733,72 @@ you need to run several workflows to publish the documentation. More details abo
[Docs README](../docs/README.md) showing the architecture and workflows including manual workflows for
emergency cases.

There are two steps to publish the documentation:
There are two ways to publish the documentation - using breeze command from your local machine or
using breeze commands from GitHub Actions. Both are actually execute remote workflows in GitHub Actions.

1. Publish the documentation to the `live` S3 bucket.
### Using breeze commands

The release manager publishes the documentation using GitHub Actions workflow
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml).
You can use the `breeze` command to publish the documentation.
The command does the following:

1. Triggers [Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml).
2. Triggers workflow in apache/airflow-site to refresh
3. Triggers S3 to GitHub Sync

```shell script
breeze workflow-run publish-docs --ref <tag> --site-env <staging/live/auto> helm-chart
```

The `--ref` parameter should be the tag of the release candidate you are publishing. This should be a
release tag like `helm-chart/1.1.0`

The `--site-env` parameter should be set to `staging` for pre-release versions or `live` for final releases.
The default option is `auto` which should automatically select the right environment based on the tag name.

Other available parameters can be found with:

```shell script
breeze workflow-run publish-docs --help
```

You should specify the tag to use to build the docs and 'helm-chart' passed as packages to be built.
One of the interesting features of publishing this way is that you can also rebuild historical version of
the documentation with patches applied to the documentation (if they can be applied cleanly).

Yoy should specify the `--apply-commits` parameter with the list of commits you want to apply
separated by commas and the workflow will apply those commits to the documentation before
building it. (don't forget to add --skip-write-to-stable-folder if you are publishing
previous version of the distribution). Example:

```shell script
breeze workflow-run publish-docs --ref helm-chart/1.18.0 --site-env staging \
 --apply-commits 4ae273cbedec66c87dc40218c7a94863390a380d,e61e9618bdd6be8213d277b1427f67079fcb1d9b \
 --skip-write-to-stable-folder \
 helm-chart
```

### Manually using GitHub Actions

There are two steps to publish the documentation:

1. Publish the documentation to the `staging` S3 bucket.

The release manager publishes the documentation using GitHub Actions workflow
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml). By default
`auto` selection should publish to the `live` bucket - based on
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml). By default `auto` selection should publish to the `staging` bucket - based on
the tag you use - pre-release tags go to staging. But you can also override it and specify the destination
manually to be `live` or `staging`.

After that step, the provider documentation should be available under the https://airflow.apache.org
(same as in the helm chart documentation).
You should specify 'helm-chart' passed as packages to be built.

After that step, the provider documentation should be available under https://airflow.stage.apache.org//
URL (RC PyPI packages are build with the staging urls) but stable links and drop-down boxes are not updated yet.

2. Invalidated Fastly cache for the documentation.
2. Invalidate Fastly cache, update version drop-down and stable links with the new versions of the documentation.

In order to do it, you need to run the [Build docs](https://github.com/apache/airflow-site/actions/workflows/build.yml)
workflow in `airflow-site` repository. Make sure to use `main` branch.
workflow in `airflow-site` repository - but make sure to use `staging` branch.

After that workflow completes, the new version should be available in the drop-down list and stable links
should be updated and Fastly cache should be invalidated.
should be updated, also Fastly cache will be updated

## Update `index.yaml` in airflow-site

Expand Down

1 change: 1 addition & 0 deletions
dev/breeze/src/airflow_breeze/commands/workflow_commands.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,7 @@ def workflow_run_publish(
 get_console().print(
 f"[red]Error: Ref {ref} does not exists in repo apache/airflow .[/red]",
 )
 get_console().print("\nYou can add --skip-tag-validation to skip this validation.")
 sys.exit(1)

 get_console().print(
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255) by github-actions[bot] · Pull Request #57257 · apache/airflow · GitHub
Skip to content
[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255)#57257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

potiuk
merged 1 commit into

from

Oct 25, 2025
 Merged


[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255)
#57257
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


65 changes: 53 additions & 12 deletions
dev/README_RELEASE_HELM_CHART.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -733,31 +733,72 @@ you need to run several workflows to publish the documentation. More details abo
[Docs README](../docs/README.md) showing the architecture and workflows including manual workflows for
emergency cases.

There are two steps to publish the documentation:
There are two ways to publish the documentation - using breeze command from your local machine or
using breeze commands from GitHub Actions. Both are actually execute remote workflows in GitHub Actions.

1. Publish the documentation to the `live` S3 bucket.
### Using breeze commands

The release manager publishes the documentation using GitHub Actions workflow
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml).
You can use the `breeze` command to publish the documentation.
The command does the following:

1. Triggers [Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml).
2. Triggers workflow in apache/airflow-site to refresh
3. Triggers S3 to GitHub Sync

```shell script
breeze workflow-run publish-docs --ref <tag> --site-env <staging/live/auto> helm-chart
```

The `--ref` parameter should be the tag of the release candidate you are publishing. This should be a
release tag like `helm-chart/1.1.0`

The `--site-env` parameter should be set to `staging` for pre-release versions or `live` for final releases.
The default option is `auto` which should automatically select the right environment based on the tag name.

Other available parameters can be found with:

```shell script
breeze workflow-run publish-docs --help
```

You should specify the tag to use to build the docs and 'helm-chart' passed as packages to be built.
One of the interesting features of publishing this way is that you can also rebuild historical version of
the documentation with patches applied to the documentation (if they can be applied cleanly).

Yoy should specify the `--apply-commits` parameter with the list of commits you want to apply
separated by commas and the workflow will apply those commits to the documentation before
building it. (don't forget to add --skip-write-to-stable-folder if you are publishing
previous version of the distribution). Example:

```shell script
breeze workflow-run publish-docs --ref helm-chart/1.18.0 --site-env staging \
 --apply-commits 4ae273cbedec66c87dc40218c7a94863390a380d,e61e9618bdd6be8213d277b1427f67079fcb1d9b \
 --skip-write-to-stable-folder \
 helm-chart
```

### Manually using GitHub Actions

There are two steps to publish the documentation:

1. Publish the documentation to the `staging` S3 bucket.

The release manager publishes the documentation using GitHub Actions workflow
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml). By default
`auto` selection should publish to the `live` bucket - based on
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml). By default `auto` selection should publish to the `staging` bucket - based on
the tag you use - pre-release tags go to staging. But you can also override it and specify the destination
manually to be `live` or `staging`.

After that step, the provider documentation should be available under the https://airflow.apache.org
(same as in the helm chart documentation).
You should specify 'helm-chart' passed as packages to be built.

After that step, the provider documentation should be available under https://airflow.stage.apache.org//
URL (RC PyPI packages are build with the staging urls) but stable links and drop-down boxes are not updated yet.

2. Invalidated Fastly cache for the documentation.
2. Invalidate Fastly cache, update version drop-down and stable links with the new versions of the documentation.

In order to do it, you need to run the [Build docs](https://github.com/apache/airflow-site/actions/workflows/build.yml)
workflow in `airflow-site` repository. Make sure to use `main` branch.
workflow in `airflow-site` repository - but make sure to use `staging` branch.

After that workflow completes, the new version should be available in the drop-down list and stable links
should be updated and Fastly cache should be invalidated.
should be updated, also Fastly cache will be updated

## Update `index.yaml` in airflow-site

Expand Down

1 change: 1 addition & 0 deletions
dev/breeze/src/airflow_breeze/commands/workflow_commands.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,7 @@ def workflow_run_publish(
 get_console().print(
 f"[red]Error: Ref {ref} does not exists in repo apache/airflow .[/red]",
 )
 get_console().print("\nYou can add --skip-tag-validation to skip this validation.")
 sys.exit(1)

 get_console().print(
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255) by github-actions[bot] · Pull Request #57257 · apache/airflow · GitHub
Skip to content
[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255)#57257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

potiuk
merged 1 commit into

from

Oct 25, 2025
 Merged


[v3-1-test] Update release docs for Helm Chart to use breeze workflow-run (#57255)
#57257
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


65 changes: 53 additions & 12 deletions
dev/README_RELEASE_HELM_CHART.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -733,31 +733,72 @@ you need to run several workflows to publish the documentation. More details abo
[Docs README](../docs/README.md) showing the architecture and workflows including manual workflows for
emergency cases.

There are two steps to publish the documentation:
There are two ways to publish the documentation - using breeze command from your local machine or
using breeze commands from GitHub Actions. Both are actually execute remote workflows in GitHub Actions.

1. Publish the documentation to the `live` S3 bucket.
### Using breeze commands

The release manager publishes the documentation using GitHub Actions workflow
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml).
You can use the `breeze` command to publish the documentation.
The command does the following:

1. Triggers [Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml).
2. Triggers workflow in apache/airflow-site to refresh
3. Triggers S3 to GitHub Sync

```shell script
breeze workflow-run publish-docs --ref <tag> --site-env <staging/live/auto> helm-chart
```

The `--ref` parameter should be the tag of the release candidate you are publishing. This should be a
release tag like `helm-chart/1.1.0`

The `--site-env` parameter should be set to `staging` for pre-release versions or `live` for final releases.
The default option is `auto` which should automatically select the right environment based on the tag name.

Other available parameters can be found with:

```shell script
breeze workflow-run publish-docs --help
```

You should specify the tag to use to build the docs and 'helm-chart' passed as packages to be built.
One of the interesting features of publishing this way is that you can also rebuild historical version of
the documentation with patches applied to the documentation (if they can be applied cleanly).

Yoy should specify the `--apply-commits` parameter with the list of commits you want to apply
separated by commas and the workflow will apply those commits to the documentation before
building it. (don't forget to add --skip-write-to-stable-folder if you are publishing
previous version of the distribution). Example:

```shell script
breeze workflow-run publish-docs --ref helm-chart/1.18.0 --site-env staging \
 --apply-commits 4ae273cbedec66c87dc40218c7a94863390a380d,e61e9618bdd6be8213d277b1427f67079fcb1d9b \
 --skip-write-to-stable-folder \
 helm-chart
```

### Manually using GitHub Actions

There are two steps to publish the documentation:

1. Publish the documentation to the `staging` S3 bucket.

The release manager publishes the documentation using GitHub Actions workflow
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml). By default
`auto` selection should publish to the `live` bucket - based on
[Publish Docs to S3](https://github.com/apache/airflow/actions/workflows/publish-docs-to-s3.yml). By default `auto` selection should publish to the `staging` bucket - based on
the tag you use - pre-release tags go to staging. But you can also override it and specify the destination
manually to be `live` or `staging`.

After that step, the provider documentation should be available under the https://airflow.apache.org
(same as in the helm chart documentation).
You should specify 'helm-chart' passed as packages to be built.

After that step, the provider documentation should be available under https://airflow.stage.apache.org//
URL (RC PyPI packages are build with the staging urls) but stable links and drop-down boxes are not updated yet.

2. Invalidated Fastly cache for the documentation.
2. Invalidate Fastly cache, update version drop-down and stable links with the new versions of the documentation.

In order to do it, you need to run the [Build docs](https://github.com/apache/airflow-site/actions/workflows/build.yml)
workflow in `airflow-site` repository. Make sure to use `main` branch.
workflow in `airflow-site` repository - but make sure to use `staging` branch.

After that workflow completes, the new version should be available in the drop-down list and stable links
should be updated and Fastly cache should be invalidated.
should be updated, also Fastly cache will be updated

## Update `index.yaml` in airflow-site

Expand Down

1 change: 1 addition & 0 deletions
dev/breeze/src/airflow_breeze/commands/workflow_commands.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,7 @@ def workflow_run_publish(
 get_console().print(
 f"[red]Error: Ref {ref} does not exists in repo apache/airflow .[/red]",
 )
 get_console().print("\nYou can add --skip-tag-validation to skip this validation.")
 sys.exit(1)

 get_console().print(
Expand Down