golioth / docs

Creative Commons Attribution Share Alike 4.0 International
6 stars 11 forks source link

Update board catalog generator #412

Closed szczys closed 1 month ago

szczys commented 4 months ago

Zephyr 3.7 implements a new hardware model that changes the path to each board definition, and the naming of the yaml files in those definitions. This commit updates the automatic generation of the Golioth device catalog to work with the new model.

Running this script

rm -rf static/img/boards/
rm -rf docs/firmware/hardware/assets/boards.json 
rm -rf docs/firmware/hardware/6-catalog/continuously-verified/
rm -rf docs/firmware/hardware/6-catalog/verified/
rm -rf docs/firmware/hardware/6-catalog/unverified/
npm run build-device-catalog

resolves https://github.com/golioth/devrel-issue-tracker/issues/418

szczys commented 4 months ago

The build will pass when commands listed above are run. That will remove old generated files and regenerate them. I didn't want to do that before the review because it will bloat the PR with 1.2k files changed

szczys commented 4 months ago

This PR is waiting on the release of Zephyr v3.7.0 and the adoption of it by the Golioth Firmware SDK. Once this happens, one more commit should be made:

Before merging:

  1. Remove all generated device catalog files
    rm -rf static/img/boards/
    rm docs/firmware/hardware/assets/boards.json 
    rm -rf docs/firmware/hardware/6-catalog/continuously-verified/
    rm -rf docs/firmware/hardware/6-catalog/verified/
    rm -rf docs/firmware/hardware/6-catalog/unverified/
  2. Generate new files
    npm run build-device-catalog
  3. Add to git in hopes that unchanged files (images) are recognized as a rename
    git add -u
    git add docs/firmware/hardware/6-catalog/
    git add static/img/boards/
  4. Commit and push
    git commit -s
    git push --force
  5. Confirm that tests pass
github-actions[bot] commented 1 month ago

Visit the preview URL for this PR (updated for commit c306a69):

https://golioth-docs-dev--pr412-szczys-update-board-0x23f2jf.web.app

(expires Sat, 05 Oct 2024 18:03:54 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: f53b02bdc98ce6f5593931ec4c339aa96bac84df