erriez / erriezgithubactionsplatformiodoxygen

Erriez Github Actions CI build with PlatformIO and generate Doxygen gh-pages and PDF

Erriez Arduino Github Actions Template

This is a template repository for Erriez Arduino libraries to test Github Actions with PlatformIO and Doxygen.

Files and Directories

• src/, examples/, keywords.txt and library.properties:
  • Minimum Arduino template library (doing nothing special).
• Doxygen:
  • Doxygen configuration file.
• .auto-build.sh:
  • Bash script to build Arduino libary with PlatformIO and Doxygen HTML/PDF on Linux.
• .github/ISSUE_TEMPLATE/*.yaml:
  • Github issue templates to enforce user to enter relevant information.
• .github/PULL_REQUESTS_TEMPLATE.md:
  • Github pull request template. Note: yaml format is not supported yet.
• .github/worksflows/actions.yml:
  • Github Actions to build Arduino library with PlatformIO and deploy Doxygen HTML to gh-pages.

Github Project Configuration

• Project Settings:
  • General:
    • Check: Issues
  • Actions | General:
    • Customize for your needs
  • Pages:
    • Source: Deploy from a branch
    • Branch: gh-pages, / (root)

Github documentation to configure permissions secrets.GITHUB_TOKEN.

Generated Arduino Library Doxygen Documenation

• Online Doxygen HTML
• Doxygen PDF

MIT License

This project is published under MIT license with an additional end user agreement (next section).

End User Agreement 🇺🇦

End users shall accept the End User Agreement holding export restrictions to Russia to stop the WAR before using this project.