Skip to content

Commit ab6775b

Browse files
andrewsy-opalandrewsy-opal
authored
Merge pull request #8 from opalsecurity/andrewsy-autogen
Add Github action to autogen SDK
2 parents 814603d + 89a7aca commit ab6775b

File tree

9 files changed

+117
-17
lines changed

9 files changed

+117
-17
lines changed

‎.github/workflows/autogen-remote-changes.yml‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: Auto-Update SDK
2+
3+
on:
4+
schedule:
5+
- cron: "0 0 * * 1" # Runs every Monday at midnight
6+
workflow_dispatch: # Allows manual triggering of the workflow
7+
8+
jobs:
9+
update-sdk:
10+
runs-on: ubuntu-latest
11+
strategy:
12+
matrix:
13+
python-version: ["3.12"]
14+
steps:
15+
- uses: actions/checkout@v3
16+
- name: Set up Python ${{ matrix.python-version }}
17+
uses: actions/setup-python@v5
18+
with:
19+
python-version: ${{ matrix.python-version }}
20+
- name: Set up Node.js
21+
uses: actions/setup-node@v3
22+
with:
23+
node-version: '18'
24+
- name: Install OpenAPI Generator CLI
25+
run: npm install @openapitools/openapi-generator-cli -g
26+
- name: Install dependencies
27+
run: |
28+
python -m pip install --upgrade pip
29+
pip install -r requirements.txt
30+
- name: Pull and generate SDK
31+
run: make gen-openapi-remote-for-ci
32+
- name: Check for changes
33+
id: check_changes
34+
run: |
35+
if git diff --quiet; then
36+
echo "changes=false" >> $GITHUB_ENV
37+
else
38+
echo "changes=true" >> $GITHUB_ENV
39+
fi
40+
- name: Set up Git
41+
if: env.changes == 'true'
42+
run: |
43+
git config user.name "github-actions[bot]"
44+
git config user.email "github-actions[bot]@users.noreply.github.com"
45+
- name: Commit changes
46+
if: env.changes == 'true'
47+
run: |
48+
BRANCH_NAME="auto-update-sdk-$(date +'%Y-%m-%d-%H-%M-%S')"
49+
echo "BRANCH_NAME=$BRANCH_NAME" >> $GITHUB_ENV
50+
git checkout -b $BRANCH_NAME || git checkout $BRANCH_NAME
51+
git add .
52+
git commit -m "Auto-update SDK on $(date +'%Y-%m-%d')"
53+
- name: Push changes
54+
if: env.changes == 'true'
55+
env:
56+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
57+
run: git push --force --set-upstream origin $BRANCH_NAME
58+
- name: Install GitHub CLI
59+
if: env.changes == 'true'
60+
run: |
61+
sudo apt-get update
62+
sudo apt-get install -y gh
63+
- name: Check for existing pull request
64+
if: env.changes == 'true'
65+
env:
66+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
67+
id: check_pr
68+
run: |
69+
PR_EXISTS=$(gh pr list --search "Auto-update SDK" --base main --state open --json number -q '.[0].number')
70+
if [[ -n "$PR_EXISTS" ]]; then
71+
echo "pr_exists=true" >> $GITHUB_ENV
72+
echo "PR_NUMBER=$PR_EXISTS" >> $GITHUB_ENV
73+
else
74+
echo "pr_exists=false" >> $GITHUB_ENV
75+
fi
76+
- name: Create a pull request
77+
if: env.changes == 'true' && env.pr_exists == 'false'
78+
env:
79+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
80+
run: |
81+
PR_TITLE="Auto-update SDK on $(date +'%Y-%m-%d')"
82+
PR_BODY="This pull request was automatically created by GitHub Actions to update the SDK with the latest remote OpenAPI specification."
83+
gh pr create --title "$PR_TITLE" --body "$PR_BODY" --head $BRANCH_NAME --base main
84+
- name: Update existing pull request
85+
if: env.changes == 'true' && env.pr_exists == 'true'
86+
env:
87+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
88+
run: |
89+
echo "An existing pull request titled 'Auto-update SDK' is already open. Updating it with the latest changes."
90+
git push --set-upstream origin $BRANCH_NAME --force
91+
gh pr comment $PR_NUMBER --body "This pull request has been updated with the latest changes from the automated SDK update process on $(date +'%Y-%m-%d %H:%M:%S')."
92+

‎.github/workflows/python.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
runs-on: ubuntu-latest
1414
strategy:
1515
matrix:
16-
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
16+
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
1717

1818
steps:
1919
- uses: actions/checkout@v3

‎.gitlab-ci.yml‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,6 @@ stages:
1414
- pip install -r test-requirements.txt
1515
- pytest --cov=opal
1616

17-
pytest-3.7:
18-
extends: .pytest
19-
image: python:3.7-alpine
2017
pytest-3.8:
2118
extends: .pytest
2219
image: python:3.8-alpine

‎.openapi-generator/templates/github-workflow.mustache‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
runs-on: ubuntu-latest
1515
strategy:
1616
matrix:
17-
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
17+
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
1818

1919
steps:
2020
- uses: actions/checkout@v3

‎.travis.yml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# ref: https://docs.travis-ci.com/user/languages/python
22
language: python
33
python:
4-
- "3.7"
54
- "3.8"
65
- "3.9"
76
- "3.10"

‎Makefile‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@ SHELL:=/bin/bash
22
PYTHON_POST_PROCESS_FILE=python -m black
33

44
OPENAPI_GEN=openapi-generator generate --enable-post-process-file -i api/openapi.yaml -g python -o . -c config.json -t .openapi-generator/templates
5+
OPENAPI_GEN_CI=openapi-generator-cli generate --enable-post-process-file -i api/openapi.yaml -g python -o . -c config.json -t .openapi-generator/templates
6+
PULL_REMOTE_OPENAPI=curl https://app.opal.dev/openapi.yaml > api/openapi.yaml
57

68
gen-openapi:
79
$(OPENAPI_GEN)
810
gen-openapi-remote:
9-
curl https://app.opal.dev/openapi.yaml > api/openapi.yaml
10-
$(OPENAPI_GEN)
11+
$(PULL_REMOTE_OPENAPI)
12+
$(OPENAPI_GEN)
13+
gen-openapi-remote-for-ci:
14+
$(PULL_REMOTE_OPENAPI)
15+
$(OPENAPI_GEN_CI)

‎config.json‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,8 @@
1-
{"enumClassPrefix": true, "packageName": "opal", "gitHost": "github.com", "gitUserId": "opalsecurity", "gitRepoId": "opal-python", "disallowAdditionalPropertiesIfNotPresent":false}
1+
{
2+
"enumClassPrefix": true,
3+
"packageName": "opal",
4+
"gitHost": "github.com",
5+
"gitUserId": "opalsecurity",
6+
"gitRepoId": "opal-python",
7+
"disallowAdditionalPropertiesIfNotPresent": false
8+
}

‎requirements.txt‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
urllib3 >= 1.25.3, < 2.1.0
2-
setuptools >= 21.0.0
3-
python_dateutil >= 2.5.3
1+
urllib3 >= 1.25.3, < 3.0.0
2+
python_dateutil >= 2.8.2
43
pydantic >= 2
54
typing-extensions >= 4.7.1

‎test-requirements.txt‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
pytest~=7.1.3
2-
pytest-cov>=2.8.1
3-
pytest-randomly>=3.12.0
4-
mypy>=1.4.1
5-
types-python-dateutil>=2.8.19
1+
pytest >= 7.2.1
2+
pytest-cov >= 2.8.1
3+
tox >= 3.9.0
4+
flake8 >= 4.0.0
5+
types-python-dateutil >= 2.8.19.14
6+
mypy >= 1.5

0 commit comments

Comments
 (0)