Compare commits
14 commits
ci-wippers
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
139855f5a6 | ||
|
|
9d47c3e84c | ||
|
|
c1222e5ebb | ||
|
|
d45001870f | ||
|
|
bc9ae39b85 | ||
|
|
6a5eaa381e | ||
|
|
1806102474 | ||
|
|
491fdd9c3b | ||
|
|
809fa567ce | ||
|
|
c8a449c0a5 | ||
|
|
790b8e1943 | ||
|
|
9cacd6a3cd | ||
|
|
71a8675ae4 | ||
|
|
5a9757be18 |
3 changed files with 48 additions and 2 deletions
15
README.md
15
README.md
|
|
@ -76,3 +76,18 @@ The `doxy_gen_and_deploy.sh` script uses [Doxygen](https://www.doxygen.nl/) to g
|
|||
for the library. Any issues, like missing documentation, will cause the CI to fail.
|
||||
See the [guide](https://learn.adafruit.com/the-well-automated-arduino-library/doxygen) for details on installing and running Doxygen locally. The guide also has some
|
||||
[tips](https://learn.adafruit.com/the-well-automated-arduino-library/doxygen-tips) on basic usage of Doxygen markup within your code.
|
||||
|
||||
### Preserving Folders in Documentation Branch
|
||||
|
||||
By default, the documentation deployment script cleans the gh-pages branch before adding new documentation. If you need to preserve certain folders (like custom web interfaces), you can set the `PRESERVE_FOLDERS` environment variable in your workflow:
|
||||
|
||||
```yaml
|
||||
- name: doxygen
|
||||
env:
|
||||
GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }}
|
||||
PRETTYNAME : "My Arduino Library"
|
||||
PRESERVE_FOLDERS: "webserial,assets"
|
||||
run: bash ci/doxy_gen_and_deploy.sh
|
||||
```
|
||||
|
||||
This will preserve the listed folders (comma-separated) during the documentation generation process.
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@ ALL_PLATFORMS={
|
|||
# Arduino SAMD
|
||||
"zero" : ["arduino:samd:arduino_zero_native", "0x68ed2b88", None, None],
|
||||
"cpx" : ["arduino:samd:adafruit_circuitplayground_m0", "0x68ed2b88", None],
|
||||
# Arduino MBED GIGA
|
||||
"giga" : ["arduino:mbed_giga:giga", None, None],
|
||||
# Espressif
|
||||
"esp8266" : ["esp8266:esp8266:huzzah:eesz=4M3M,xtal=80", None, None],
|
||||
"esp32" : ["esp32:esp32:featheresp32:FlashFreq=80", None, None],
|
||||
|
|
@ -50,6 +52,8 @@ ALL_PLATFORMS={
|
|||
"qualia_s3_rgb666" : ["esp32:esp32:adafruit_qualia_s3_rgb666", "0xc47e5767", None],
|
||||
"qtpy_esp32s3" : ["esp32:esp32:adafruit_qtpy_esp32s3_nopsram", "0xc47e5767", None],
|
||||
"qtpy_esp32s3_n4r2" : ["esp32:esp32:adafruit_qtpy_esp32s3_n4r2", "0xc47e5767", None],
|
||||
# ESP32-P4
|
||||
"esp32p4" : ["esp32:esp32:esp32p4:JTAGAdapter=default,PSRAM=disabled,USBMode=default,CDCOnBoot=cdc,MSCOnBoot=default,DFUOnBoot=default,UploadMode=default,PartitionScheme=default,CPUFreq=360,FlashMode=qio,FlashFreq=80,FlashSize=4M,UploadSpeed=921600,DebugLevel=none,EraseFlash=none", "0x3d308e94", None],
|
||||
# Adafruit AVR
|
||||
"trinket_3v" : ["adafruit:avr:trinket3", None, None],
|
||||
"trinket_5v" : ["adafruit:avr:trinket5", None, None],
|
||||
|
|
@ -116,7 +120,7 @@ ALL_PLATFORMS={
|
|||
"cpb" : ["adafruit:nrf52:cplaynrf52840:softdevice=s140v6,debug=l0", "0xada52840", None],
|
||||
"clue" : ["adafruit:nrf52:cluenrf52840:softdevice=s140v6,debug=l0", "0xada52840", None],
|
||||
"ledglasses_nrf52840" : ["adafruit:nrf52:ledglasses_nrf52840:softdevice=s140v6,debug=l0", "0xada52840", None],
|
||||
# RP2040 (Philhower)
|
||||
# RP2040 & RP2350 (Philhower)
|
||||
"pico_rp2040" : ["rp2040:rp2040:rpipico:freq=125,flash=2097152_0", "0xe48bff56", None],
|
||||
"pico_rp2040_tinyusb" : ["rp2040:rp2040:rpipico:flash=2097152_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||
"pico_rp2040_tinyusb_host" : ["rp2040:rp2040:rpipico:flash=2097152_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb_host", "0xe48bff56", None],
|
||||
|
|
@ -136,6 +140,8 @@ ALL_PLATFORMS={
|
|||
"feather_rp2040_usbhost_tinyusb" : ["rp2040:rp2040:adafruit_feather_usb_host:flash=8388608_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||
"feather_rp2350" : ["rp2040:rp2040:adafruit_feather_rp2350_hstx:arch=arm,flash=8388608_0,freq=150,dbgport=Disabled,dbglvl=None,usbstack=picosdk", "0xe48bff56", None],
|
||||
"feather_rp2350_tinyusb" : ["rp2040:rp2040:adafruit_feather_rp2350_hstx:arch=arm,flash=8388608_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||
"metro_rp2040" : ["rp2040:rp2040:adafruit_metro:flash=16777216_0,freq=200,dbgport=Disabled,dbglvl=None,usbstack=picosdk", "0xe48bff56", None],
|
||||
"metro_rp2040_tinyusb" : ["rp2040:rp2040:adafruit_metro:flash=16777216_0,freq=200,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||
"metro_rp2350" : ["rp2040:rp2040:adafruit_metro_rp2350:arch=arm,flash=16777216_0,freq=150,dbgport=Disabled,dbglvl=None,usbstack=picosdk", "0xe48bff56", None],
|
||||
"metro_rp2350_tinyusb" : ["rp2040:rp2040:adafruit_metro_rp2350:arch=arm,flash=16777216_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||
"qt2040_trinkey" : ["rp2040:rp2040:adafruit_trinkeyrp2040qt:flash=8388608_0,freq=125","0xe48bff56", None],
|
||||
|
|
@ -146,7 +152,8 @@ ALL_PLATFORMS={
|
|||
"itsybitsy_rp2040_tinyusb" : ["rp2040:rp2040:adafruit_itsybitsy:flash=8388608_524288,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||
"floppsy_rp2040" : ["rp2040:rp2040:adafruit_floppsy:freq=125,flash=16777216_14680064", "0xe48bff56", None],
|
||||
"floppsy_rp2040_tinyusb" : ["rp2040:rp2040:adafruit_floppsy:flash=16777216_14680064,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||
|
||||
"fruit_jam" : ["rp2040:rp2040:adafruit_fruitjam:arch=arm,flash=16777216_0,freq=150,dbgport=Disabled,dbglvl=None,usbstack=picosdk", "0xe48bff56", None],
|
||||
"fruit_jam_tinyusb" : ["rp2040:rp2040:adafruit_fruitjam:arch=arm,flash=16777216_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||
# Attiny8xy, 16xy, 32xy (SpenceKonde)
|
||||
"attiny3217" : ["megaTinyCore:megaavr:atxy7:chip=3217", None, None],
|
||||
"attiny3216" : ["megaTinyCore:megaavr:atxy6:chip=3216", None, None],
|
||||
|
|
|
|||
|
|
@ -18,6 +18,7 @@ __AUTHOR__="Jeroen de Bruijn, modified by ladyada"
|
|||
# Optional global variables:
|
||||
# - DOXYFILE : The Doxygen configuration file.
|
||||
# - PRETTYNAME : A string name of the project (for the doxy headers)
|
||||
# - PRESERVE_FOLDERS : Comma-separated list of folders to preserve during cleanup
|
||||
#
|
||||
# For information on how to encrypt variables for Travis CI please go to
|
||||
# https://docs.travis-ci.com/user/environment-variables/#Encrypted-Variables
|
||||
|
|
@ -84,6 +85,19 @@ git config --global push.default simple
|
|||
git config user.name "Doxygen CI"
|
||||
git config user.email "ci-arduino@invalid"
|
||||
|
||||
# Check if PRESERVE_FOLDERS is set and back them up
|
||||
if [ -n "$PRESERVE_FOLDERS" ]; then
|
||||
echo "Preserving folders: $PRESERVE_FOLDERS"
|
||||
mkdir -p /tmp/preserved
|
||||
# Move preserved folders to temp dir
|
||||
for folder in ${PRESERVE_FOLDERS//,/ }; do
|
||||
if [ -d "$folder" ]; then
|
||||
echo "Backing up folder: $folder"
|
||||
cp -r "$folder" /tmp/preserved/
|
||||
fi
|
||||
done
|
||||
fi
|
||||
|
||||
# Remove everything currently in the gh-pages branch.
|
||||
# GitHub is smart enough to know which files have changed and which files have
|
||||
# stayed the same and will only update the changed files. So the gh-pages branch
|
||||
|
|
@ -99,6 +113,16 @@ else
|
|||
rm -r -- !(index.html) || true
|
||||
fi
|
||||
|
||||
# Restore preserved folders if they were backed up
|
||||
if [ -n "$PRESERVE_FOLDERS" ]; then
|
||||
for folder in ${PRESERVE_FOLDERS//,/ }; do
|
||||
if [ -d "/tmp/preserved/$folder" ]; then
|
||||
echo "Restoring folder: $folder"
|
||||
cp -r "/tmp/preserved/$folder" ./
|
||||
fi
|
||||
done
|
||||
fi
|
||||
|
||||
# Need to create a .nojekyll file to allow filenames starting with an underscore
|
||||
# to be seen on the gh-pages site. Therefore creating an empty .nojekyll file.
|
||||
# Presumably this is only needed when the SHORT_NAMES option in Doxygen is set
|
||||
|
|
|
|||
Loading…
Reference in a new issue