2
0
mirror of https://github.com/inventree/InvenTree.git synced 2025-04-27 19:16:44 +00:00

feat(docs): include docs in release (#9524) (#9578)

* add build step for docs

* various fixes after live-testing  (#349)

(cherry picked from commit 40ded29b35d6681f433898705ccd0340b07b03a5)
This commit is contained in:
Matthias Mair 2025-04-24 23:17:27 +02:00 committed by GitHub
parent e2a092ea04
commit 7090950066
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -6,10 +6,12 @@ on:
types: [published] types: [published]
permissions: permissions:
contents: read contents: read
env:
python_version: 3.9
jobs: jobs:
stable: stable:
runs-on: ubuntu-latest runs-on: ubuntu-24.04
name: Write release to stable branch name: Write release to stable branch
permissions: permissions:
contents: write contents: write
@ -32,7 +34,7 @@ jobs:
force: true force: true
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-24.04
name: Build and attest frontend name: Build and attest frontend
permissions: permissions:
id-token: write id-token: write
@ -83,3 +85,50 @@ jobs:
file: ${{ steps.attest.outputs.bundle-path}} file: ${{ steps.attest.outputs.bundle-path}}
tag: ${{ github.ref }} tag: ${{ github.ref }}
overwrite: true overwrite: true
docs:
runs-on: ubuntu-24.04
name: Build and publish documentation
permissions:
contents: write
env:
INVENTREE_DB_ENGINE: sqlite3
INVENTREE_DB_NAME: inventree
INVENTREE_MEDIA_ROOT: /home/runner/work/InvenTree/test_inventree_media
INVENTREE_STATIC_ROOT: /home/runner/work/InvenTree/test_inventree_static
INVENTREE_BACKUP_DIR: /home/runner/work/InvenTree/test_inventree_backup
INVENTREE_SITE_URL: http://localhost:8000
INVENTREE_DEBUG: true
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # pin@v4.2.2
with:
persist-credentials: false
- name: Environment Setup
uses: ./.github/actions/setup
with:
install: true
npm: true
- name: Install dependencies
run: |
pip install --require-hashes -r contrib/dev_reqs/requirements.txt
pip install --require-hashes -r docs/requirements.txt
- name: Build documentation
run: |
invoke migrate
invoke int.export-definitions --basedir "docs"
invoke dev.schema --filename docs/schema.yml --ignore-warnings
python docs/extract_schema.py docs/schema.yml
mkdocs build -f docs/mkdocs.yml
- name: Zip build docs
run: |
cd docs/site
zip -r docs-html.zip *
- name: Publish documentation
uses: svenstaro/upload-release-action@04733e069f2d7f7f0b4aebc4fbdbce8613b03ccd # pin@2.9.0
with:
repo_token: ${{ secrets.GITHUB_TOKEN }}
file: docs/site/docs-html.zip
asset_name: docs-html.zip
tag: ${{ github.ref }}
overwrite: true