Release python-sdk#8

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
pdparchitect merged 1 commit into from
Jul 22, 2026
Merged

Release python-sdk #8

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
107 changes: 77 additions & 30 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
# Release workflow for the python-sdk.
#
# Triggered by tag-release.yml (workflow_dispatch at the new tag) or by a
# manually pushed `v*` tag. Builds the sdist/wheel, publishes to PyPI (only if
# a PYPI_API_TOKEN secret is configured), and creates a GitHub Release whose
# body is the matching section from CHANGELOG.md with auto-generated commit
# notes appended.
# manually pushed `v*` tag. Builds the sdist/wheel, publishes to PyPI via a
# Trusted Publisher (OIDC - no stored API token), and creates a GitHub Release
# whose body is the matching section from CHANGELOG.md with auto-generated
# commit notes appended.
#
# To enable PyPI publishing, add a `PYPI_API_TOKEN` secret (a PyPI API token)
# to this repository. Without it, the build still runs and the GitHub Release is
# still created; only the upload step is skipped.
# ----------------------------------------------------------------------------
# Trusted Publishing setup (do this once on PyPI - no secrets in GitHub):
# https://docs.pypi.org/trusted-publishers/
#
# On https://pypi.org, add a GitHub Actions trusted publisher to the
# `chatbotkit` project (Manage -> Publishing) with these exact values:
# Owner: chatbotkit
# Repository name: python-sdk
# Workflow name: release.yml
# Environment name: pypi
#
# For the very first release (the project does not exist on PyPI yet) use a
# "pending" publisher instead: https://pypi.org/manage/account/publishing/
# with the same four values plus the project name `chatbotkit`.
#
# Also create a GitHub Environment named `pypi` on the python-sdk repo
# (Settings -> Environments) to match `environment.name` below. Add required
# reviewers there if you want a manual approval gate before every upload.
# ----------------------------------------------------------------------------
name: Release

on:
Expand All@@ -17,12 +33,15 @@ on:
- 'v*'
workflow_dispatch:

permissions:
contents: write
# No permissions by default; each job requests only what it needs.
permissions: {}

jobs:
release:
build:
name: Build distributions
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout
uses: actions/checkout@v4
Expand All@@ -41,27 +60,7 @@ jobs:
python -m build
twine check dist/*

- name: Detect PyPI token
id: token
env:
PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
run: |
if [ -n "$PYPI_API_TOKEN" ]; then
echo "present=true" >> "$GITHUB_OUTPUT"
else
echo "present=false" >> "$GITHUB_OUTPUT"
echo "PYPI_API_TOKEN not set - skipping PyPI upload." >&2
fi

- name: Publish to PyPI
if: steps.token.outputs.present == 'true'
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
run: twine upload --non-interactive dist/*

- name: Extract changelog section for this version
id: changelog
run: |
VERSION="${GITHUB_REF_NAME#v}"
if [ -f CHANGELOG.md ]; then
Expand All@@ -75,6 +74,54 @@ jobs:
echo "Release v${VERSION}. See the full changelog in CHANGELOG.md." > release-notes.md
fi

- name: Upload distributions
uses: actions/upload-artifact@v4
with:
name: dist
path: dist/

- name: Upload release notes
uses: actions/upload-artifact@v4
with:
name: release-notes
path: release-notes.md

publish-pypi:
name: Publish to PyPI
needs: build
runs-on: ubuntu-latest
# The Trusted Publisher on PyPI is scoped to this environment name.
environment:
name: pypi
url: https://pypi.org/p/chatbotkit
# OIDC: mint the short-lived token PyPI exchanges for upload rights.
# This job intentionally does nothing else (no checkout of repo code) so the
# id-token can never be exfiltrated by build/test steps.
permissions:
id-token: write
steps:
- name: Download distributions
uses: actions/download-artifact@v4
with:
name: dist
path: dist/

- name: Publish to PyPI
uses: pypa/gh-action-pypi-publish@release/v1

github-release:
name: Create GitHub Release
needs: [build, publish-pypi]
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Download release notes
uses: actions/download-artifact@v4
with:
name: release-notes
path: .

- name: Create GitHub Release
uses: softprops/action-gh-release@v2
with:
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Release python-sdk#8

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

pdparchitect
merged 1 commit into

from

Jul 22, 2026
 Merged


Release python-sdk
#8
 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


107 changes: 77 additions & 30 deletions
.github/workflows/release.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
# Release workflow for the python-sdk.
#
# Triggered by tag-release.yml (workflow_dispatch at the new tag) or by a
# manually pushed `v*` tag. Builds the sdist/wheel, publishes to PyPI (only if
# a PYPI_API_TOKEN secret is configured), and creates a GitHub Release whose
# body is the matching section from CHANGELOG.md with auto-generated commit
# notes appended.
# manually pushed `v*` tag. Builds the sdist/wheel, publishes to PyPI via a
# Trusted Publisher (OIDC - no stored API token), and creates a GitHub Release
# whose body is the matching section from CHANGELOG.md with auto-generated
# commit notes appended.
#
# To enable PyPI publishing, add a `PYPI_API_TOKEN` secret (a PyPI API token)
# to this repository. Without it, the build still runs and the GitHub Release is
# still created; only the upload step is skipped.
# ----------------------------------------------------------------------------
# Trusted Publishing setup (do this once on PyPI - no secrets in GitHub):
# https://docs.pypi.org/trusted-publishers/
#
# On https://pypi.org, add a GitHub Actions trusted publisher to the
# `chatbotkit` project (Manage -> Publishing) with these exact values:
# Owner: chatbotkit
# Repository name: python-sdk
# Workflow name: release.yml
# Environment name: pypi
#
# For the very first release (the project does not exist on PyPI yet) use a
# "pending" publisher instead: https://pypi.org/manage/account/publishing/
# with the same four values plus the project name `chatbotkit`.
#
# Also create a GitHub Environment named `pypi` on the python-sdk repo
# (Settings -> Environments) to match `environment.name` below. Add required
# reviewers there if you want a manual approval gate before every upload.
# ----------------------------------------------------------------------------
name: Release

on:
Expand All@@ -17,12 +33,15 @@ on:
 - 'v*'
 workflow_dispatch:

permissions:
 contents: write
# No permissions by default; each job requests only what it needs.
permissions: {}

jobs:
 release:
 build:
 name: Build distributions
 runs-on: ubuntu-latest
 permissions:
 contents: read
 steps:
 - name: Checkout
 uses: actions/checkout@v4
Expand All@@ -41,27 +60,7 @@ jobs:
 python -m build
 twine check dist/*

 - name: Detect PyPI token
 id: token
 env:
 PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
 run: |
 if [ -n "$PYPI_API_TOKEN" ]; then
 echo "present=true" >> "$GITHUB_OUTPUT"
 else
 echo "present=false" >> "$GITHUB_OUTPUT"
 echo "PYPI_API_TOKEN not set - skipping PyPI upload." >&2
 fi

 - name: Publish to PyPI
 if: steps.token.outputs.present == 'true'
 env:
 TWINE_USERNAME: __token__
 TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
 run: twine upload --non-interactive dist/*

 - name: Extract changelog section for this version
 id: changelog
 run: |
 VERSION="${GITHUB_REF_NAME#v}"
 if [ -f CHANGELOG.md ]; then
Expand All@@ -75,6 +74,54 @@ jobs:
 echo "Release v${VERSION}. See the full changelog in CHANGELOG.md." > release-notes.md
 fi

 - name: Upload distributions
 uses: actions/upload-artifact@v4
 with:
 name: dist
 path: dist/

 - name: Upload release notes
 uses: actions/upload-artifact@v4
 with:
 name: release-notes
 path: release-notes.md

 publish-pypi:
 name: Publish to PyPI
 needs: build
 runs-on: ubuntu-latest
 # The Trusted Publisher on PyPI is scoped to this environment name.
 environment:
 name: pypi
 url: https://pypi.org/p/chatbotkit
 # OIDC: mint the short-lived token PyPI exchanges for upload rights.
 # This job intentionally does nothing else (no checkout of repo code) so the
 # id-token can never be exfiltrated by build/test steps.
 permissions:
 id-token: write
 steps:
 - name: Download distributions
 uses: actions/download-artifact@v4
 with:
 name: dist
 path: dist/

 - name: Publish to PyPI
 uses: pypa/gh-action-pypi-publish@release/v1

 github-release:
 name: Create GitHub Release
 needs: [build, publish-pypi]
 runs-on: ubuntu-latest
 permissions:
 contents: write
 steps:
 - name: Download release notes
 uses: actions/download-artifact@v4
 with:
 name: release-notes
 path: .

 - name: Create GitHub Release
 uses: softprops/action-gh-release@v2
 with:
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Release python-sdk#8

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

pdparchitect
merged 1 commit into

from

Jul 22, 2026
 Merged


Release python-sdk
#8
 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


107 changes: 77 additions & 30 deletions
.github/workflows/release.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
# Release workflow for the python-sdk.
#
# Triggered by tag-release.yml (workflow_dispatch at the new tag) or by a
# manually pushed `v*` tag. Builds the sdist/wheel, publishes to PyPI (only if
# a PYPI_API_TOKEN secret is configured), and creates a GitHub Release whose
# body is the matching section from CHANGELOG.md with auto-generated commit
# notes appended.
# manually pushed `v*` tag. Builds the sdist/wheel, publishes to PyPI via a
# Trusted Publisher (OIDC - no stored API token), and creates a GitHub Release
# whose body is the matching section from CHANGELOG.md with auto-generated
# commit notes appended.
#
# To enable PyPI publishing, add a `PYPI_API_TOKEN` secret (a PyPI API token)
# to this repository. Without it, the build still runs and the GitHub Release is
# still created; only the upload step is skipped.
# ----------------------------------------------------------------------------
# Trusted Publishing setup (do this once on PyPI - no secrets in GitHub):
# https://docs.pypi.org/trusted-publishers/
#
# On https://pypi.org, add a GitHub Actions trusted publisher to the
# `chatbotkit` project (Manage -> Publishing) with these exact values:
# Owner: chatbotkit
# Repository name: python-sdk
# Workflow name: release.yml
# Environment name: pypi
#
# For the very first release (the project does not exist on PyPI yet) use a
# "pending" publisher instead: https://pypi.org/manage/account/publishing/
# with the same four values plus the project name `chatbotkit`.
#
# Also create a GitHub Environment named `pypi` on the python-sdk repo
# (Settings -> Environments) to match `environment.name` below. Add required
# reviewers there if you want a manual approval gate before every upload.
# ----------------------------------------------------------------------------
name: Release

on:
Expand All@@ -17,12 +33,15 @@ on:
 - 'v*'
 workflow_dispatch:

permissions:
 contents: write
# No permissions by default; each job requests only what it needs.
permissions: {}

jobs:
 release:
 build:
 name: Build distributions
 runs-on: ubuntu-latest
 permissions:
 contents: read
 steps:
 - name: Checkout
 uses: actions/checkout@v4
Expand All@@ -41,27 +60,7 @@ jobs:
 python -m build
 twine check dist/*

 - name: Detect PyPI token
 id: token
 env:
 PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
 run: |
 if [ -n "$PYPI_API_TOKEN" ]; then
 echo "present=true" >> "$GITHUB_OUTPUT"
 else
 echo "present=false" >> "$GITHUB_OUTPUT"
 echo "PYPI_API_TOKEN not set - skipping PyPI upload." >&2
 fi

 - name: Publish to PyPI
 if: steps.token.outputs.present == 'true'
 env:
 TWINE_USERNAME: __token__
 TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
 run: twine upload --non-interactive dist/*

 - name: Extract changelog section for this version
 id: changelog
 run: |
 VERSION="${GITHUB_REF_NAME#v}"
 if [ -f CHANGELOG.md ]; then
Expand All@@ -75,6 +74,54 @@ jobs:
 echo "Release v${VERSION}. See the full changelog in CHANGELOG.md." > release-notes.md
 fi

 - name: Upload distributions
 uses: actions/upload-artifact@v4
 with:
 name: dist
 path: dist/

 - name: Upload release notes
 uses: actions/upload-artifact@v4
 with:
 name: release-notes
 path: release-notes.md

 publish-pypi:
 name: Publish to PyPI
 needs: build
 runs-on: ubuntu-latest
 # The Trusted Publisher on PyPI is scoped to this environment name.
 environment:
 name: pypi
 url: https://pypi.org/p/chatbotkit
 # OIDC: mint the short-lived token PyPI exchanges for upload rights.
 # This job intentionally does nothing else (no checkout of repo code) so the
 # id-token can never be exfiltrated by build/test steps.
 permissions:
 id-token: write
 steps:
 - name: Download distributions
 uses: actions/download-artifact@v4
 with:
 name: dist
 path: dist/

 - name: Publish to PyPI
 uses: pypa/gh-action-pypi-publish@release/v1

 github-release:
 name: Create GitHub Release
 needs: [build, publish-pypi]
 runs-on: ubuntu-latest
 permissions:
 contents: write
 steps:
 - name: Download release notes
 uses: actions/download-artifact@v4
 with:
 name: release-notes
 path: .

 - name: Create GitHub Release
 uses: softprops/action-gh-release@v2
 with:
Expand Down
Loading

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

Skip to content
Release python-sdk#8

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

pdparchitect
merged 1 commit into

from

Jul 22, 2026
 Merged


Release python-sdk
#8
 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


107 changes: 77 additions & 30 deletions
.github/workflows/release.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
# Release workflow for the python-sdk.
#
# Triggered by tag-release.yml (workflow_dispatch at the new tag) or by a
# manually pushed `v*` tag. Builds the sdist/wheel, publishes to PyPI (only if
# a PYPI_API_TOKEN secret is configured), and creates a GitHub Release whose
# body is the matching section from CHANGELOG.md with auto-generated commit
# notes appended.
# manually pushed `v*` tag. Builds the sdist/wheel, publishes to PyPI via a
# Trusted Publisher (OIDC - no stored API token), and creates a GitHub Release
# whose body is the matching section from CHANGELOG.md with auto-generated
# commit notes appended.
#
# To enable PyPI publishing, add a `PYPI_API_TOKEN` secret (a PyPI API token)
# to this repository. Without it, the build still runs and the GitHub Release is
# still created; only the upload step is skipped.
# ----------------------------------------------------------------------------
# Trusted Publishing setup (do this once on PyPI - no secrets in GitHub):
# https://docs.pypi.org/trusted-publishers/
#
# On https://pypi.org, add a GitHub Actions trusted publisher to the
# `chatbotkit` project (Manage -> Publishing) with these exact values:
# Owner: chatbotkit
# Repository name: python-sdk
# Workflow name: release.yml
# Environment name: pypi
#
# For the very first release (the project does not exist on PyPI yet) use a
# "pending" publisher instead: https://pypi.org/manage/account/publishing/
# with the same four values plus the project name `chatbotkit`.
#
# Also create a GitHub Environment named `pypi` on the python-sdk repo
# (Settings -> Environments) to match `environment.name` below. Add required
# reviewers there if you want a manual approval gate before every upload.
# ----------------------------------------------------------------------------
name: Release

on:
Expand All@@ -17,12 +33,15 @@ on:
 - 'v*'
 workflow_dispatch:

permissions:
 contents: write
# No permissions by default; each job requests only what it needs.
permissions: {}

jobs:
 release:
 build:
 name: Build distributions
 runs-on: ubuntu-latest
 permissions:
 contents: read
 steps:
 - name: Checkout
 uses: actions/checkout@v4
Expand All@@ -41,27 +60,7 @@ jobs:
 python -m build
 twine check dist/*

 - name: Detect PyPI token
 id: token
 env:
 PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
 run: |
 if [ -n "$PYPI_API_TOKEN" ]; then
 echo "present=true" >> "$GITHUB_OUTPUT"
 else
 echo "present=false" >> "$GITHUB_OUTPUT"
 echo "PYPI_API_TOKEN not set - skipping PyPI upload." >&2
 fi

 - name: Publish to PyPI
 if: steps.token.outputs.present == 'true'
 env:
 TWINE_USERNAME: __token__
 TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
 run: twine upload --non-interactive dist/*

 - name: Extract changelog section for this version
 id: changelog
 run: |
 VERSION="${GITHUB_REF_NAME#v}"
 if [ -f CHANGELOG.md ]; then
Expand All@@ -75,6 +74,54 @@ jobs:
 echo "Release v${VERSION}. See the full changelog in CHANGELOG.md." > release-notes.md
 fi

 - name: Upload distributions
 uses: actions/upload-artifact@v4
 with:
 name: dist
 path: dist/

 - name: Upload release notes
 uses: actions/upload-artifact@v4
 with:
 name: release-notes
 path: release-notes.md

 publish-pypi:
 name: Publish to PyPI
 needs: build
 runs-on: ubuntu-latest
 # The Trusted Publisher on PyPI is scoped to this environment name.
 environment:
 name: pypi
 url: https://pypi.org/p/chatbotkit
 # OIDC: mint the short-lived token PyPI exchanges for upload rights.
 # This job intentionally does nothing else (no checkout of repo code) so the
 # id-token can never be exfiltrated by build/test steps.
 permissions:
 id-token: write
 steps:
 - name: Download distributions
 uses: actions/download-artifact@v4
 with:
 name: dist
 path: dist/

 - name: Publish to PyPI
 uses: pypa/gh-action-pypi-publish@release/v1

 github-release:
 name: Create GitHub Release
 needs: [build, publish-pypi]
 runs-on: ubuntu-latest
 permissions:
 contents: write
 steps:
 - name: Download release notes
 uses: actions/download-artifact@v4
 with:
 name: release-notes
 path: .

 - name: Create GitHub Release
 uses: softprops/action-gh-release@v2
 with:
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Release python-sdk#8

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

pdparchitect
merged 1 commit into

from

Jul 22, 2026
 Merged


Release python-sdk
#8
 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


107 changes: 77 additions & 30 deletions
.github/workflows/release.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
# Release workflow for the python-sdk.
#
# Triggered by tag-release.yml (workflow_dispatch at the new tag) or by a
# manually pushed `v*` tag. Builds the sdist/wheel, publishes to PyPI (only if
# a PYPI_API_TOKEN secret is configured), and creates a GitHub Release whose
# body is the matching section from CHANGELOG.md with auto-generated commit
# notes appended.
# manually pushed `v*` tag. Builds the sdist/wheel, publishes to PyPI via a
# Trusted Publisher (OIDC - no stored API token), and creates a GitHub Release
# whose body is the matching section from CHANGELOG.md with auto-generated
# commit notes appended.
#
# To enable PyPI publishing, add a `PYPI_API_TOKEN` secret (a PyPI API token)
# to this repository. Without it, the build still runs and the GitHub Release is
# still created; only the upload step is skipped.
# ----------------------------------------------------------------------------
# Trusted Publishing setup (do this once on PyPI - no secrets in GitHub):
# https://docs.pypi.org/trusted-publishers/
#
# On https://pypi.org, add a GitHub Actions trusted publisher to the
# `chatbotkit` project (Manage -> Publishing) with these exact values:
# Owner: chatbotkit
# Repository name: python-sdk
# Workflow name: release.yml
# Environment name: pypi
#
# For the very first release (the project does not exist on PyPI yet) use a
# "pending" publisher instead: https://pypi.org/manage/account/publishing/
# with the same four values plus the project name `chatbotkit`.
#
# Also create a GitHub Environment named `pypi` on the python-sdk repo
# (Settings -> Environments) to match `environment.name` below. Add required
# reviewers there if you want a manual approval gate before every upload.
# ----------------------------------------------------------------------------
name: Release

on:
Expand All@@ -17,12 +33,15 @@ on:
 - 'v*'
 workflow_dispatch:

permissions:
 contents: write
# No permissions by default; each job requests only what it needs.
permissions: {}

jobs:
 release:
 build:
 name: Build distributions
 runs-on: ubuntu-latest
 permissions:
 contents: read
 steps:
 - name: Checkout
 uses: actions/checkout@v4
Expand All@@ -41,27 +60,7 @@ jobs:
 python -m build
 twine check dist/*

 - name: Detect PyPI token
 id: token
 env:
 PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
 run: |
 if [ -n "$PYPI_API_TOKEN" ]; then
 echo "present=true" >> "$GITHUB_OUTPUT"
 else
 echo "present=false" >> "$GITHUB_OUTPUT"
 echo "PYPI_API_TOKEN not set - skipping PyPI upload." >&2
 fi

 - name: Publish to PyPI
 if: steps.token.outputs.present == 'true'
 env:
 TWINE_USERNAME: __token__
 TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
 run: twine upload --non-interactive dist/*

 - name: Extract changelog section for this version
 id: changelog
 run: |
 VERSION="${GITHUB_REF_NAME#v}"
 if [ -f CHANGELOG.md ]; then
Expand All@@ -75,6 +74,54 @@ jobs:
 echo "Release v${VERSION}. See the full changelog in CHANGELOG.md." > release-notes.md
 fi

 - name: Upload distributions
 uses: actions/upload-artifact@v4
 with:
 name: dist
 path: dist/

 - name: Upload release notes
 uses: actions/upload-artifact@v4
 with:
 name: release-notes
 path: release-notes.md

 publish-pypi:
 name: Publish to PyPI
 needs: build
 runs-on: ubuntu-latest
 # The Trusted Publisher on PyPI is scoped to this environment name.
 environment:
 name: pypi
 url: https://pypi.org/p/chatbotkit
 # OIDC: mint the short-lived token PyPI exchanges for upload rights.
 # This job intentionally does nothing else (no checkout of repo code) so the
 # id-token can never be exfiltrated by build/test steps.
 permissions:
 id-token: write
 steps:
 - name: Download distributions
 uses: actions/download-artifact@v4
 with:
 name: dist
 path: dist/

 - name: Publish to PyPI
 uses: pypa/gh-action-pypi-publish@release/v1

 github-release:
 name: Create GitHub Release
 needs: [build, publish-pypi]
 runs-on: ubuntu-latest
 permissions:
 contents: write
 steps:
 - name: Download release notes
 uses: actions/download-artifact@v4
 with:
 name: release-notes
 path: .

 - name: Create GitHub Release
 uses: softprops/action-gh-release@v2
 with:
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Release python-sdk#8

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

pdparchitect
merged 1 commit into

from

Jul 22, 2026
 Merged


Release python-sdk
#8
 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


107 changes: 77 additions & 30 deletions
.github/workflows/release.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
# Release workflow for the python-sdk.
#
# Triggered by tag-release.yml (workflow_dispatch at the new tag) or by a
# manually pushed `v*` tag. Builds the sdist/wheel, publishes to PyPI (only if
# a PYPI_API_TOKEN secret is configured), and creates a GitHub Release whose
# body is the matching section from CHANGELOG.md with auto-generated commit
# notes appended.
# manually pushed `v*` tag. Builds the sdist/wheel, publishes to PyPI via a
# Trusted Publisher (OIDC - no stored API token), and creates a GitHub Release
# whose body is the matching section from CHANGELOG.md with auto-generated
# commit notes appended.
#
# To enable PyPI publishing, add a `PYPI_API_TOKEN` secret (a PyPI API token)
# to this repository. Without it, the build still runs and the GitHub Release is
# still created; only the upload step is skipped.
# ----------------------------------------------------------------------------
# Trusted Publishing setup (do this once on PyPI - no secrets in GitHub):
# https://docs.pypi.org/trusted-publishers/
#
# On https://pypi.org, add a GitHub Actions trusted publisher to the
# `chatbotkit` project (Manage -> Publishing) with these exact values:
# Owner: chatbotkit
# Repository name: python-sdk
# Workflow name: release.yml
# Environment name: pypi
#
# For the very first release (the project does not exist on PyPI yet) use a
# "pending" publisher instead: https://pypi.org/manage/account/publishing/
# with the same four values plus the project name `chatbotkit`.
#
# Also create a GitHub Environment named `pypi` on the python-sdk repo
# (Settings -> Environments) to match `environment.name` below. Add required
# reviewers there if you want a manual approval gate before every upload.
# ----------------------------------------------------------------------------
name: Release

on:
Expand All@@ -17,12 +33,15 @@ on:
 - 'v*'
 workflow_dispatch:

permissions:
 contents: write
# No permissions by default; each job requests only what it needs.
permissions: {}

jobs:
 release:
 build:
 name: Build distributions
 runs-on: ubuntu-latest
 permissions:
 contents: read
 steps:
 - name: Checkout
 uses: actions/checkout@v4
Expand All@@ -41,27 +60,7 @@ jobs:
 python -m build
 twine check dist/*

 - name: Detect PyPI token
 id: token
 env:
 PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
 run: |
 if [ -n "$PYPI_API_TOKEN" ]; then
 echo "present=true" >> "$GITHUB_OUTPUT"
 else
 echo "present=false" >> "$GITHUB_OUTPUT"
 echo "PYPI_API_TOKEN not set - skipping PyPI upload." >&2
 fi

 - name: Publish to PyPI
 if: steps.token.outputs.present == 'true'
 env:
 TWINE_USERNAME: __token__
 TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
 run: twine upload --non-interactive dist/*

 - name: Extract changelog section for this version
 id: changelog
 run: |
 VERSION="${GITHUB_REF_NAME#v}"
 if [ -f CHANGELOG.md ]; then
Expand All@@ -75,6 +74,54 @@ jobs:
 echo "Release v${VERSION}. See the full changelog in CHANGELOG.md." > release-notes.md
 fi

 - name: Upload distributions
 uses: actions/upload-artifact@v4
 with:
 name: dist
 path: dist/

 - name: Upload release notes
 uses: actions/upload-artifact@v4
 with:
 name: release-notes
 path: release-notes.md

 publish-pypi:
 name: Publish to PyPI
 needs: build
 runs-on: ubuntu-latest
 # The Trusted Publisher on PyPI is scoped to this environment name.
 environment:
 name: pypi
 url: https://pypi.org/p/chatbotkit
 # OIDC: mint the short-lived token PyPI exchanges for upload rights.
 # This job intentionally does nothing else (no checkout of repo code) so the
 # id-token can never be exfiltrated by build/test steps.
 permissions:
 id-token: write
 steps:
 - name: Download distributions
 uses: actions/download-artifact@v4
 with:
 name: dist
 path: dist/

 - name: Publish to PyPI
 uses: pypa/gh-action-pypi-publish@release/v1

 github-release:
 name: Create GitHub Release
 needs: [build, publish-pypi]
 runs-on: ubuntu-latest
 permissions:
 contents: write
 steps:
 - name: Download release notes
 uses: actions/download-artifact@v4
 with:
 name: release-notes
 path: .

 - name: Create GitHub Release
 uses: softprops/action-gh-release@v2
 with:
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Release python-sdk#8

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

pdparchitect
merged 1 commit into

from

Jul 22, 2026
 Merged


Release python-sdk
#8
 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


107 changes: 77 additions & 30 deletions
.github/workflows/release.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
# Release workflow for the python-sdk.
#
# Triggered by tag-release.yml (workflow_dispatch at the new tag) or by a
# manually pushed `v*` tag. Builds the sdist/wheel, publishes to PyPI (only if
# a PYPI_API_TOKEN secret is configured), and creates a GitHub Release whose
# body is the matching section from CHANGELOG.md with auto-generated commit
# notes appended.
# manually pushed `v*` tag. Builds the sdist/wheel, publishes to PyPI via a
# Trusted Publisher (OIDC - no stored API token), and creates a GitHub Release
# whose body is the matching section from CHANGELOG.md with auto-generated
# commit notes appended.
#
# To enable PyPI publishing, add a `PYPI_API_TOKEN` secret (a PyPI API token)
# to this repository. Without it, the build still runs and the GitHub Release is
# still created; only the upload step is skipped.
# ----------------------------------------------------------------------------
# Trusted Publishing setup (do this once on PyPI - no secrets in GitHub):
# https://docs.pypi.org/trusted-publishers/
#
# On https://pypi.org, add a GitHub Actions trusted publisher to the
# `chatbotkit` project (Manage -> Publishing) with these exact values:
# Owner: chatbotkit
# Repository name: python-sdk
# Workflow name: release.yml
# Environment name: pypi
#
# For the very first release (the project does not exist on PyPI yet) use a
# "pending" publisher instead: https://pypi.org/manage/account/publishing/
# with the same four values plus the project name `chatbotkit`.
#
# Also create a GitHub Environment named `pypi` on the python-sdk repo
# (Settings -> Environments) to match `environment.name` below. Add required
# reviewers there if you want a manual approval gate before every upload.
# ----------------------------------------------------------------------------
name: Release

on:
Expand All@@ -17,12 +33,15 @@ on:
 - 'v*'
 workflow_dispatch:

permissions:
 contents: write
# No permissions by default; each job requests only what it needs.
permissions: {}

jobs:
 release:
 build:
 name: Build distributions
 runs-on: ubuntu-latest
 permissions:
 contents: read
 steps:
 - name: Checkout
 uses: actions/checkout@v4
Expand All@@ -41,27 +60,7 @@ jobs:
 python -m build
 twine check dist/*

 - name: Detect PyPI token
 id: token
 env:
 PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
 run: |
 if [ -n "$PYPI_API_TOKEN" ]; then
 echo "present=true" >> "$GITHUB_OUTPUT"
 else
 echo "present=false" >> "$GITHUB_OUTPUT"
 echo "PYPI_API_TOKEN not set - skipping PyPI upload." >&2
 fi

 - name: Publish to PyPI
 if: steps.token.outputs.present == 'true'
 env:
 TWINE_USERNAME: __token__
 TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
 run: twine upload --non-interactive dist/*

 - name: Extract changelog section for this version
 id: changelog
 run: |
 VERSION="${GITHUB_REF_NAME#v}"
 if [ -f CHANGELOG.md ]; then
Expand All@@ -75,6 +74,54 @@ jobs:
 echo "Release v${VERSION}. See the full changelog in CHANGELOG.md." > release-notes.md
 fi

 - name: Upload distributions
 uses: actions/upload-artifact@v4
 with:
 name: dist
 path: dist/

 - name: Upload release notes
 uses: actions/upload-artifact@v4
 with:
 name: release-notes
 path: release-notes.md

 publish-pypi:
 name: Publish to PyPI
 needs: build
 runs-on: ubuntu-latest
 # The Trusted Publisher on PyPI is scoped to this environment name.
 environment:
 name: pypi
 url: https://pypi.org/p/chatbotkit
 # OIDC: mint the short-lived token PyPI exchanges for upload rights.
 # This job intentionally does nothing else (no checkout of repo code) so the
 # id-token can never be exfiltrated by build/test steps.
 permissions:
 id-token: write
 steps:
 - name: Download distributions
 uses: actions/download-artifact@v4
 with:
 name: dist
 path: dist/

 - name: Publish to PyPI
 uses: pypa/gh-action-pypi-publish@release/v1

 github-release:
 name: Create GitHub Release
 needs: [build, publish-pypi]
 runs-on: ubuntu-latest
 permissions:
 contents: write
 steps:
 - name: Download release notes
 uses: actions/download-artifact@v4
 with:
 name: release-notes
 path: .

 - name: Create GitHub Release
 uses: softprops/action-gh-release@v2
 with:
Expand Down
Loading

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

Skip to content
Release python-sdk#8

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

pdparchitect
merged 1 commit into

from

Jul 22, 2026
 Merged


Release python-sdk
#8
 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


107 changes: 77 additions & 30 deletions
.github/workflows/release.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
# Release workflow for the python-sdk.
#
# Triggered by tag-release.yml (workflow_dispatch at the new tag) or by a
# manually pushed `v*` tag. Builds the sdist/wheel, publishes to PyPI (only if
# a PYPI_API_TOKEN secret is configured), and creates a GitHub Release whose
# body is the matching section from CHANGELOG.md with auto-generated commit
# notes appended.
# manually pushed `v*` tag. Builds the sdist/wheel, publishes to PyPI via a
# Trusted Publisher (OIDC - no stored API token), and creates a GitHub Release
# whose body is the matching section from CHANGELOG.md with auto-generated
# commit notes appended.
#
# To enable PyPI publishing, add a `PYPI_API_TOKEN` secret (a PyPI API token)
# to this repository. Without it, the build still runs and the GitHub Release is
# still created; only the upload step is skipped.
# ----------------------------------------------------------------------------
# Trusted Publishing setup (do this once on PyPI - no secrets in GitHub):
# https://docs.pypi.org/trusted-publishers/
#
# On https://pypi.org, add a GitHub Actions trusted publisher to the
# `chatbotkit` project (Manage -> Publishing) with these exact values:
# Owner: chatbotkit
# Repository name: python-sdk
# Workflow name: release.yml
# Environment name: pypi
#
# For the very first release (the project does not exist on PyPI yet) use a
# "pending" publisher instead: https://pypi.org/manage/account/publishing/
# with the same four values plus the project name `chatbotkit`.
#
# Also create a GitHub Environment named `pypi` on the python-sdk repo
# (Settings -> Environments) to match `environment.name` below. Add required
# reviewers there if you want a manual approval gate before every upload.
# ----------------------------------------------------------------------------
name: Release

on:
Expand All@@ -17,12 +33,15 @@ on:
 - 'v*'
 workflow_dispatch:

permissions:
 contents: write
# No permissions by default; each job requests only what it needs.
permissions: {}

jobs:
 release:
 build:
 name: Build distributions
 runs-on: ubuntu-latest
 permissions:
 contents: read
 steps:
 - name: Checkout
 uses: actions/checkout@v4
Expand All@@ -41,27 +60,7 @@ jobs:
 python -m build
 twine check dist/*

 - name: Detect PyPI token
 id: token
 env:
 PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
 run: |
 if [ -n "$PYPI_API_TOKEN" ]; then
 echo "present=true" >> "$GITHUB_OUTPUT"
 else
 echo "present=false" >> "$GITHUB_OUTPUT"
 echo "PYPI_API_TOKEN not set - skipping PyPI upload." >&2
 fi

 - name: Publish to PyPI
 if: steps.token.outputs.present == 'true'
 env:
 TWINE_USERNAME: __token__
 TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
 run: twine upload --non-interactive dist/*

 - name: Extract changelog section for this version
 id: changelog
 run: |
 VERSION="${GITHUB_REF_NAME#v}"
 if [ -f CHANGELOG.md ]; then
Expand All@@ -75,6 +74,54 @@ jobs:
 echo "Release v${VERSION}. See the full changelog in CHANGELOG.md." > release-notes.md
 fi

 - name: Upload distributions
 uses: actions/upload-artifact@v4
 with:
 name: dist
 path: dist/

 - name: Upload release notes
 uses: actions/upload-artifact@v4
 with:
 name: release-notes
 path: release-notes.md

 publish-pypi:
 name: Publish to PyPI
 needs: build
 runs-on: ubuntu-latest
 # The Trusted Publisher on PyPI is scoped to this environment name.
 environment:
 name: pypi
 url: https://pypi.org/p/chatbotkit
 # OIDC: mint the short-lived token PyPI exchanges for upload rights.
 # This job intentionally does nothing else (no checkout of repo code) so the
 # id-token can never be exfiltrated by build/test steps.
 permissions:
 id-token: write
 steps:
 - name: Download distributions
 uses: actions/download-artifact@v4
 with:
 name: dist
 path: dist/

 - name: Publish to PyPI
 uses: pypa/gh-action-pypi-publish@release/v1

 github-release:
 name: Create GitHub Release
 needs: [build, publish-pypi]
 runs-on: ubuntu-latest
 permissions:
 contents: write
 steps:
 - name: Download release notes
 uses: actions/download-artifact@v4
 with:
 name: release-notes
 path: .

 - name: Create GitHub Release
 uses: softprops/action-gh-release@v2
 with:
Expand Down
Loading