api.yml

 1name: Update API Data
 2
 3permissions:
 4  contents: read
 5
 6on:
 7  push:
 8    branches:
 9    - master
10    - develop
11    paths:
12    - 'keyboards/**'
13    - 'layouts/community/**'
14    - 'lib/python/**'
15    - 'data/**'
16    - '.github/workflows/api.yml'
17  workflow_dispatch:
18
19jobs:
20  api_data:
21    runs-on: ubuntu-latest
22    container: ghcr.io/qmk/qmk_cli
23
24    # protect against those who work in their fork on 'important' branches
25    if: github.repository == 'qmk/qmk_firmware'
26
27    steps:
28    - uses: actions/checkout@v4
29      with:
30        fetch-depth: 1
31        persist-credentials: false
32
33    - name: Install dependencies
34      run: |
35        pip3 install -r requirements-dev.txt
36
37    - name: Generate API Data
38      run: |
39        qmk generate-api
40
41    - name: Upload API Data
42      uses: jakejarvis/s3-sync-action@master
43      with:
44        args: --acl public-read --follow-symlinks --delete
45      env:
46        AWS_S3_BUCKET: ${{ github.ref == 'refs/heads/develop' && secrets['API_SPACE_DEVELOP'] || secrets['API_SPACE_MASTER'] }}
47        AWS_ACCESS_KEY_ID: ${{ secrets.SPACES_ACCESS_KEY }}
48        AWS_SECRET_ACCESS_KEY: ${{ secrets.SPACES_SECRET_KEY }}
49        AWS_S3_ENDPOINT: https://nyc3.digitaloceanspaces.com
50        SOURCE_DIR: '.build/api_data'