Skip to content
Merged
Show file tree
Hide file tree
Changes from 22 commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
0599bd6
Javadoc versioning (#1871)
samfreund Apr 10, 2025
0fab859
Update photon-code-docs.yml
samfreund Apr 10, 2025
a618c0f
who needs if-statements anyways
samfreund Apr 10, 2025
6e2d027
Update photon-code-docs.yml
samfreund Apr 10, 2025
a0b4c63
Update photon-code-docs.yml
samfreund Apr 10, 2025
ac9777b
Update photon-code-docs.yml
samfreund Apr 10, 2025
6c187ca
Update photon-code-docs.yml
samfreund Apr 10, 2025
107cfa0
Update photon-code-docs.yml
samfreund Apr 10, 2025
453595b
Update photon-code-docs.yml
samfreund Apr 10, 2025
10323e0
Update camera-matching.md
samfreund Apr 10, 2025
3cae2ba
Update photon-code-docs.yml
samfreund Apr 10, 2025
cf93f6d
Update photon-code-docs.yml
samfreund Apr 10, 2025
162eff9
Update photon-code-docs.yml
samfreund Apr 10, 2025
7642e49
Update photon-code-docs.yml
samfreund Apr 10, 2025
ff77571
Update photon-code-docs.yml
samfreund Apr 10, 2025
2b0c534
Update photon-code-docs.yml
samfreund Apr 10, 2025
4f8660a
Update photon-code-docs.yml
samfreund Apr 10, 2025
d131d39
Update photon-code-docs.yml
samfreund Apr 10, 2025
5936a1f
not the linter :skull:
samfreund Apr 10, 2025
9f5c452
Update photon-code-docs.yml
samfreund Apr 10, 2025
9d3350e
Update photon-code-docs.yml
samfreund Apr 10, 2025
1750336
Update photon-code-docs.yml
samfreund Apr 10, 2025
e898fec
Run on all commits
mcm001 Apr 10, 2025
f63f01e
Revert "Run on all commits"
mcm001 Apr 10, 2025
d7408f7
redo workflow
samfreund Apr 10, 2025
ff26a55
Update photon-api-docs.yml
samfreund Apr 10, 2025
5de5394
Update photon-api-docs.yml
samfreund Apr 10, 2025
c33cc6b
Update photon-api-docs.yml
samfreund Apr 10, 2025
747ba2d
Update photon-api-docs.yml
samfreund Apr 10, 2025
e28899f
Update photon-api-docs.yml
samfreund Apr 10, 2025
16290a0
Update photon-api-docs.yml
samfreund Apr 10, 2025
38eb305
Update photon-api-docs.yml
samfreund Apr 10, 2025
e0a79c8
Update photon-api-docs.yml
samfreund Apr 10, 2025
4322ee1
Update photon-api-docs.yml
samfreund Apr 10, 2025
06ca367
Update photon-api-docs.yml
samfreund Apr 10, 2025
03e8999
Update photon-api-docs.yml
samfreund Apr 10, 2025
1eb9462
Update photon-api-docs.yml
samfreund Apr 10, 2025
0583127
Update photon-api-docs.yml
samfreund Apr 10, 2025
e0caf8b
Update photon-api-docs.yml
samfreund Apr 10, 2025
340a401
Update photon-api-docs.yml
samfreund Apr 10, 2025
39c57e0
Update photon-api-docs.yml
samfreund Apr 10, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 42 additions & 14 deletions .github/workflows/photon-code-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ permissions:
id-token: write

jobs:
build-client:
name: "PhotonClient Build"
build-demo:
defaults:
run:
working-directory: photon-client
Expand All @@ -39,7 +38,7 @@ jobs:
run: npm run build-demo
- uses: actions/upload-artifact@v4
with:
name: built-client
name: built-demo
path: photon-client/dist/

run_docs:
Expand Down Expand Up @@ -67,23 +66,52 @@ jobs:
name: built-docs
path: photon-docs/build/docs

release:
needs: [build-client, run_docs]
publish_docs:
needs: [run_docs]

runs-on: ubuntu-22.04
steps:

# Download literally every single artifact.
# Download docs artifact
- uses: actions/download-artifact@v4
with:
name: built-docs

- run: find .
- name: copy file via ssh password
- name: Publish docs to development
if: github.ref == 'refs/heads/main'
uses: appleboy/scp-action@v0.1.7
uses: up9cloud/action-rsync@v1.4
env:
HOST: ${{ secrets.WEBMASTER_SSH_HOST }}
USER: ${{ secrets.WEBMASTER_SSH_USERNAME }}
PASSWORD: ${{secrets.WEBMASTER_SSH_KEY}}
PORT: ${{ secrets.WEBMASTER_SSH_PORT}}
TARGET: /var/www/html/photonvision-docs/development
- name: publish docs to release
if: startsWith(github.ref, 'refs/tags/v')
uses: up9cloud/action-rsync@v1.4
env:
HOST: ${{ secrets.WEBMASTER_SSH_HOST }}
USER: ${{ secrets.WEBMASTER_SSH_USERNAME }}
PASSWORD: ${{secrets.WEBMASTER_SSH_KEY}}
PORT: ${{ secrets.WEBMASTER_SSH_PORT}}
TARGET: /var/www/html/photonvision-docs/release/

publish_demo:
needs: [build-demo]

runs-on: ubuntu-22.04
steps:
- uses: actions/download-artifact@v4
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/
name: built-demo
- run: find .
- name: Publish demo
if: github.ref == 'refs/heads/main'
uses: up9cloud/action-rsync@v1.4
env:
HOST: ${{ secrets.WEBMASTER_SSH_HOST }}
USER: ${{ secrets.WEBMASTER_SSH_USERNAME }}
PASSWORD: ${{secrets.WEBMASTER_SSH_KEY}}
PORT: ${{ secrets.WEBMASTER_SSH_PORT}}
TARGET: /var/www/html/photonvision-demo
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Diagrams generated by the [PlantUML UML editor](https://www.plantuml.com/plantum

## Initial Setup

When PhotonVision first starts, settings are loaded from disk and [VisionSources](https://javadocs.photonvision.org/org/photonvision/vision/processes/VisionSource.html) are created for every serialized & active [Camera Configuration](https://javadocs.photonvision.org/org/photonvision/common/configuration/CameraConfiguration.html)
When PhotonVision first starts, settings are loaded from disk and [VisionSources](https://javadocs.photonvision.org/release/org/photonvision/vision/processes/VisionSource.html) are created for every serialized & active [Camera Configuration](https://javadocs.photonvision.org/release/org/photonvision/common/configuration/CameraConfiguration.html)

![](https://www.plantuml.com/plantuml/png/VP5FQnin4CNl-XI3JotK-DAJAI6fIw6GfOMbFkKoramSqTKVfF6MVFkETfKsei6trVpUldbwkYs2MIv-CeI29omCcn5d9XXPn8LpsG0MAErWaggTTGc3m6P05nRizQD7HrTS3336IxOC0mOySrwqS_5lIeT8bubxgVTNN9jRhpYCXvXNP8lLpokxsWvZNcwtlQaNsSDzH8B773sGAxzC7MvlDFSUxeXWKie4DeP7futelC8z73AZCDnPSJD35xKOh5F5DR31IU3d-1aiUive06PTlSRTm_V4eH4uFJ-4Aamn2xmxFMyJojDx0x2AjtNn-WSJ73_UltRyzC_o2mjRQH1IZecpE4t5WPOmX_5R7sPof_NyVvwghNbK-LVL1sbErTneFLqxNxF27pdEZZXNs8gjbJFrhHdYLxMredrx1Obm70QZvnUBtKxdJE2NnosxNVj3qIYO1GB_Rb3DEZAlQxKPowMuS7u8oIMUNE0F84-PaOgvvK0NF_q1)

Expand Down
Loading