docs(junction/content-api): adding auto generation of docs (#5) #9
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: CI | |
on: | |
merge_group: | |
push: | |
branches: | |
- 'master' | |
tags: [ 'v*' ] | |
pull_request: | |
branches: | |
- 'master' | |
permissions: {} | |
jobs: | |
lint: | |
name: Linter | |
runs-on: ubuntu-latest | |
timeout-minutes: 5 | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Setup Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.x' | |
cache: 'pip' | |
cache-dependency-path: '**/requirements*.txt' | |
- name: Install dependencies | |
uses: py-actions/py-dependency-install@v4 | |
with: | |
path: requirements.txt | |
- name: Mypy | |
run: mypy | |
- name: Install itself | |
run: | | |
pip install . | |
- name: Prepare twine checker | |
run: | | |
pip install -U build twine wheel | |
python -m build | |
- name: Run twine checker | |
run: twine check dist/* | |
deploy: | |
name: Deploy | |
permissions: | |
id-token: write | |
contents: write | |
runs-on: ubuntu-latest | |
needs: [lint] | |
if: github.event_name == 'push' && contains(github.ref, 'refs/tags/') | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Setup Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.x' | |
- name: Install dependencies | |
run: | |
python -m pip install -U pip wheel setuptools build twine | |
- name: Build dists | |
run: | | |
python -m build | |
- name: PyPI upload | |
uses: pypa/gh-action-pypi-publish@release/v1 | |
- name: GitHub Release | |
uses: ncipollo/release-action@v1 | |
with: | |
name: junction-sdk | |
artifacts: dist/* | |
token: ${{ secrets.GITHUB_TOKEN }} |