Skip to content

Commit 4ce1317

Browse files
authored
CI: api reference for release (#1776)
1 parent 33eab29 commit 4ce1317

1 file changed

Lines changed: 31 additions & 2 deletions

File tree

.github/workflows/release.yml

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ jobs:
1313
steps:
1414
- name: Checking out sources
1515
uses: actions/checkout@v4
16-
- name: Set up Python 3.9
16+
- name: Set up Python 3.11
1717
uses: actions/setup-python@v5
1818
with:
19-
python-version: "3.9"
19+
python-version: "3.11"
2020
- name: Check _version.py was updated
2121
env:
2222
PYTHONPATH: ./src
@@ -109,6 +109,35 @@ jobs:
109109
push: true
110110
tags: evidently/evidently-service:${{ steps.generate-tag.outputs.generated-tag }},evidently/evidently-service:latest
111111

112+
generate-and-save-api-reference:
113+
name: Generate API reference documentation from PyPI version
114+
runs-on: ubuntu-22.04
115+
needs:
116+
- publish_to_pypi
117+
118+
steps:
119+
- uses: actions/checkout@v4
120+
- name: 📚 Generate and upload API reference
121+
uses: ./.github/share-actions/generate-and-save-api-reference
122+
with:
123+
source-flag: --pypi-version ${{ github.ref_name }}
124+
125+
download-and-deploy-api-reference:
126+
name: Download and deploy API reference documentation
127+
runs-on: ubuntu-22.04
128+
needs:
129+
- generate-and-save-api-reference
130+
permissions:
131+
contents: write
132+
steps:
133+
- uses: actions/checkout@v4
134+
with:
135+
ref: gh-pages
136+
137+
# this action exists in `gh-pages` branch
138+
- name: 📚 Download and deploy API reference documentation
139+
uses: ./.github/share-actions/deploy-just-saved-api-reference
140+
112141
create_release:
113142
name: Create release for the Tag
114143
runs-on: [ubuntu-22.04]

0 commit comments

Comments
 (0)