-
Notifications
You must be signed in to change notification settings - Fork 196
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
215 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
name: Photon Code Documentation | ||
|
||
on: | ||
# Run on pushes to master and pushed tags, and on pull requests against master, but ignore the docs folder | ||
push: | ||
branches: [ master ] | ||
tags: | ||
- 'v*' | ||
paths: | ||
- '**' | ||
- '!docs/**' | ||
- '.github/**' | ||
pull_request: | ||
branches: [ master ] | ||
paths: | ||
- '**' | ||
- '!docs/**' | ||
- '.github/**' | ||
|
||
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.ref }} | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
build-client: | ||
name: "PhotonClient Build" | ||
defaults: | ||
run: | ||
working-directory: photon-client | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Setup Node.js | ||
uses: actions/setup-node@v4 | ||
with: | ||
node-version: 18 | ||
- name: Install Dependencies | ||
run: npm ci | ||
- name: Build Production Client | ||
run: npm run build-demo | ||
- uses: actions/upload-artifact@v4 | ||
with: | ||
name: built-client | ||
path: photon-client/dist/ | ||
|
||
run_docs: | ||
runs-on: "ubuntu-22.04" | ||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
- name: Fetch tags | ||
run: git fetch --tags --force | ||
- name: Install Java 17 | ||
uses: actions/setup-java@v4 | ||
with: | ||
java-version: 17 | ||
distribution: temurin | ||
|
||
- name: Build javadocs/doxygen | ||
run: | | ||
chmod +x gradlew | ||
./gradlew photon-docs:generateJavaDocs photon-docs:doxygen | ||
- uses: actions/upload-artifact@v4 | ||
with: | ||
name: built-docs | ||
path: photon-docs/build/docs | ||
|
||
release: | ||
needs: [build-client, run_docs] | ||
|
||
runs-on: ubuntu-22.04 | ||
steps: | ||
|
||
# Download literally every single artifact. | ||
- uses: actions/download-artifact@v4 | ||
|
||
- run: find . | ||
- name: copy file via ssh password | ||
if: github.ref == 'refs/heads/master' | ||
uses: appleboy/[email protected] | ||
with: | ||
host: ${{ secrets.WEBMASTER_SSH_HOST }} | ||
username: ${{ secrets.WEBMASTER_SSH_USERNAME }} | ||
password: ${{ secrets.WEBMASTER_SSH_KEY }} | ||
port: ${{ secrets.WEBMASTER_SSH_PORT }} | ||
source: "*" | ||
target: /var/www/html/photonvision-docs/ |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
name: PhotonVision Sphinx Documentation Checks | ||
|
||
on: | ||
push: | ||
branches: [ master ] | ||
paths: | ||
- 'docs/**' | ||
- '.github/**' | ||
pull_request: | ||
branches: [ master ] | ||
paths: | ||
- 'docs/**' | ||
- '.github/**' | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-22.04 | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- uses: actions/setup-python@v4 | ||
with: | ||
python-version: '3.11' | ||
|
||
- name: Install and upgrade pip | ||
run: python -m pip install --upgrade pip | ||
|
||
- name: Install graphviz | ||
run: | | ||
sudo apt-get update | ||
sudo apt-get -y install graphviz | ||
- name: Install Python dependencies | ||
working-directory: docs | ||
run: | | ||
pip install sphinx sphinx_rtd_theme sphinx-tabs sphinxext-opengraph doc8 | ||
pip install -r requirements.txt | ||
- name: Check links | ||
working-directory: docs | ||
run: make linkcheck | ||
continue-on-error: true | ||
|
||
- name: Check lint | ||
working-directory: docs | ||
run: make lint | ||
|
||
- name: Compile HTML | ||
working-directory: docs | ||
run: make html |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
name: Build and Distribute PhotonLibPy | ||
|
||
permissions: | ||
id-token: write # IMPORTANT: this permission is mandatory for trusted publishing | ||
|
||
on: | ||
push: | ||
branches: [ master ] | ||
tags: | ||
- 'v*' | ||
paths: | ||
- '**' | ||
- '!docs/**' | ||
- '.github/**' | ||
pull_request: | ||
branches: [ master ] | ||
paths: | ||
- '**' | ||
- '!docs/**' | ||
- '.github/**' | ||
|
||
jobs: | ||
buildAndDeploy: | ||
runs-on: ubuntu-22.04 | ||
|
||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: 3.11 | ||
|
||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install setuptools wheel pytest | ||
- name: Build wheel | ||
working-directory: ./photon-lib/py | ||
run: | | ||
python setup.py sdist bdist_wheel | ||
- name: Run Unit Tests | ||
working-directory: ./photon-lib/py | ||
run: | | ||
pip install --no-cache-dir dist/*.whl | ||
pytest | ||
- name: Upload artifacts | ||
uses: actions/upload-artifact@master | ||
with: | ||
name: dist | ||
path: ./photon-lib/py/dist/ | ||
|
||
- name: Publish package distributions to TestPyPI | ||
# Only upload on tags | ||
if: startsWith(github.ref, 'refs/tags/v') | ||
uses: pypa/gh-action-pypi-publish@release/v1 | ||
with: | ||
packages_dir: ./photon-lib/py/dist/ | ||
|
||
permissions: | ||
id-token: write # IMPORTANT: this permission is mandatory for trusted publishing |