Skip to content

Commit e57ed80

Browse files
titusfortnertitusfortner
committed
[build] successful pre-release kicks off docs update kicks off bump in nightly
Docs need to be released with the release version When pre-release PR is successfully merged, An update-docs PR will be created and auto-merged When update-docs PR is successfully merged, A bump-nightly-version PR is created and auto-merged Using PRs just to track potential problems, everything should auto close and clean
1 parent 9dd1aa9 commit e57ed80

File tree

3 files changed

+83
-22
lines changed

3 files changed

+83
-22
lines changed

‎.github/workflows/pre-release.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ jobs:
3434
fi
3535
git checkout -b rust-release-${{ github.event.inputs.version }}
3636
- name: Update Rust Version
37-
run: |
38-
./go rust:version ${{ github.event.inputs.version }}
37+
run: ./go rust:version ${{ github.event.inputs.version }}
3938
- name: Commit Rust updates
4039
run: git commit -m "update selenium manager version and rust changelog"
4140
- name: Push changes

‎.github/workflows/update-docs-after-action.yml

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Update Version After Docs Merge
2+
3+
on:
4+
pull_request:
5+
types: [closed]
6+
branches:
7+
- gh-pages
8+
paths:
9+
- 'docs/api/**'
10+
11+
jobs:
12+
update-version:
13+
if: github.event.pull_request.merged == true && contains(github.event.pull_request.title, 'Update documentation for Selenium')
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout trunk branch
17+
uses: actions/checkout@v4
18+
with:
19+
ref: trunk
20+
token: ${{ secrets.SELENIUM_CI_TOKEN }}
21+
22+
- name: Setup git
23+
run: |
24+
git config --local user.email "[email protected]"
25+
git config --local user.name "Selenium CI Bot"
26+
27+
- name: Update versions to nightly
28+
run: ./go all:version nightly
29+
30+
- name: Bump Nightly Versions Pull Request
31+
id: cpr
32+
uses: peter-evans/create-pull-request@v6
33+
with:
34+
token: ${{ secrets.SELENIUM_CI_TOKEN }}
35+
author: Selenium CI Bot <[email protected]>
36+
delete-branch: true
37+
branch: bump-nightly-version
38+
title: Update to nightly versions
39+
body: |
40+
This PR bumps the bindings to nightly versions after merging
41+
the PR updating the API documentation.
42+
43+
- Auto-generated by [workflow run #${{ github.run_id }}](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})
44+
labels: B-docs
45+
draft: false
46+
- name: Enable Pull Request Auto-merge
47+
if: steps.cpr.outputs.pull-request-operation == 'created'
48+
uses: peter-evans/enable-pull-request-automerge@v3
49+
with:
50+
token: ${{ secrets.SELENIUM_CI_TOKEN }}
51+
pull-request-number: ${{ steps.cpr.outputs.pull-request-number }}
52+
merge-method: squash

‎.github/workflows/update-documentation.yml

+30-20
Original file line numberDiff line numberDiff line change
@@ -40,21 +40,19 @@ jobs:
4040
determine-languages:
4141
runs-on: ubuntu-latest
4242
outputs:
43-
matrix: ${{ steps.set-matrix.outputs.matrix }}
43+
languages: ${{ steps.set-languages.outputs.languages }}
4444
steps:
45-
- id: set-matrix
45+
- id: set-languages
4646
run: |
4747
if [ "${{ inputs.language }}" == "all" ]; then
48-
echo 'matrix={"language":["java","rb","py","dotnet","node"]}' >> $GITHUB_OUTPUT
48+
echo '"languages=java rb py dotnet node" >> $GITHUB_OUTPUT
4949
else
50-
echo 'matrix={"language":["${{ inputs.language }}"]}' >> $GITHUB_OUTPUT
50+
echo "languages=${{ inputs.language }}" >> $GITHUB_OUTPUT
5151
fi
52+
5253
build-docs:
5354
needs: determine-languages
5455
runs-on: ubuntu-latest
55-
strategy:
56-
matrix: ${{ fromJson(needs.determine-languages.outputs.matrix) }}
57-
fail-fast: false
5856
steps:
5957
- name: Checkout repository
6058
uses: actions/checkout@v4
@@ -69,43 +67,55 @@ jobs:
6967
- name: Setup curl for Ubuntu
7068
run: sudo apt-get update && sudo apt-get install -y libcurl4-openssl-dev
7169
- name: Setup Java
70+
if: contains(needs.determine-languages.outputs.languages, 'java')
7271
uses: actions/setup-java@v4
7372
with:
7473
java-version: 17
7574
distribution: 'temurin'
7675
- name: Set up Python 3.9
77-
if: ${{ matrix.language == 'py' }}
76+
if: contains(needs.determine-languages.outputs.languages, 'py')
7877
uses: actions/setup-python@v5
7978
with:
8079
python-version: 3.9
8180
- name: Install dependencies
82-
if: ${{ matrix.language == 'py' }}
81+
if: contains(needs.determine-languages.outputs.languages, 'py')
8382
run: |
8483
python -m pip install --upgrade pip
8584
pip install tox
8685
- name: Install npm dependencies
87-
if: ${{ matrix.language == 'node' }}
86+
if: contains(needs.determine-languages.outputs.languages, 'node')
8887
run: |
8988
npm install
9089
npm install --prefix javascript/selenium-webdriver
91-
- name: Update Documentation
92-
run: ./go ${{ matrix.language }}:docs
90+
- name: Generate Documentation for selected langauges
91+
run: |
92+
read -r -a LANGS <<< "${{ needs.determine-languages.outputs.languages }}"
93+
for lang in "${LANGS[@]}"; do
94+
echo "Generating docs for $lang"
95+
./go $lang:docs
96+
done
9397
- name: Documentation Pull Request
98+
id: cpr
9499
uses: peter-evans/create-pull-request@v6
95100
with:
96101
token: ${{ secrets.SELENIUM_CI_TOKEN }}
97102
author: Selenium CI Bot <[email protected]>
98103
delete-branch: true
99-
branch: api-docs-${{ inputs.version }}-${{ matrix.language }}
104+
branch: api-docs-${{ inputs.version }}
100105
base: gh-pages
101-
add-paths: |
102-
${{ matrix.language == 'node' && 'docs/api/javascript/**' || format('docs/api/{0}/**', matrix.language) }}
103-
title: Update documentation for Selenium ${{ inputs.version }} (${{ matrix.language }})
106+
add-paths: docs/api/**
107+
title: Update documentation for Selenium ${{ inputs.version }}
104108
body: |
105-
This PR updates the API documentation for **${{ matrix.language }}** language bindings to version **${{ inputs.version }}**.
106-
107-
- Auto-generated by [create-pull-request][1]
109+
This PR updates the API documentation for version **${{ inputs.version }}**.
110+
Languages updated: ${{ needs.determine-languages.outputs.languages }}
108111
109-
[1]: https://github.com/peter-evans/create-pull-request
112+
- Auto-generated by [workflow run #${{ github.run_id }}](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})
110113
labels: B-docs
111114
draft: false
115+
- name: Enable Pull Request Auto-merge
116+
if: steps.cpr.outputs.pull-request-operation == 'created'
117+
uses: peter-evans/enable-pull-request-automerge@v3
118+
with:
119+
token: ${{ secrets.SELENIUM_CI_TOKEN }}
120+
pull-request-number: ${{ steps.cpr.outputs.pull-request-number }}
121+
merge-method: squash

0 commit comments

Comments
 (0)