https://github.com/erriez/erriezgithubactionsplatformiodoxygen

Erriez Github Actions CI build with PlatformIO and generate Doxygen gh-pages and PDF
https://github.com/erriez/erriezgithubactionsplatformiodoxygen

actions arduino build ci doxygen github issues library platformio pull-request templates

Last synced: 11 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/erriez/erriezgithubactionsplatformiodoxygen
• Owner: Erriez
• License: mit
• Created: 2022-08-21T13:49:58.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-01T01:14:33.000Z (almost 2 years ago)
• Last Synced: 2024-10-11T00:35:15.896Z (about 1 month ago)
• Topics: actions, arduino, build, ci, doxygen, github, issues, library, platformio, pull-request, templates
• Language: C++
• Homepage:
• Size: 934 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![Licence MIT](https://img.shields.io/badge/license-MIT-green)](https://github.com/Erriez/ErriezGithubActionsPlatformIODoxygen/blob/main/LICENSE)

[![Language C/C++](https://img.shields.io/badge/language-C%2FC%2B%2B-informational)](https://github.com/Erriez/ErriezGithubActionsPlatformIODoxygen)

[![Release tag](https://img.shields.io/github/v/release/Erriez/ErriezGithubActionsPlatformIODoxygen?display_name=tag)](https://github.com/Erriez/ErriezGithubActionsPlatformIODoxygen/releases)

[![Open issue](https://shields.io/github/issues-raw/Erriez/ErriezGithubActionsPlatformIODoxygen)](https://github.com/Erriez/ErriezGithubActionsPlatformIODoxygen/issues)

[![PlatformIO CI](https://github.com/Erriez/ErriezGithubActionsPlatformIODoxygen/actions/workflows/actions.yml/badge.svg)](https://github.com/Erriez/ErriezGithubActionsPlatformIODoxygen/actions/workflows/actions.yml)

# 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](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms) to enforce user to enter relevant information.

* `.github/PULL_REQUESTS_TEMPLATE.md`: 

    - [Github pull request template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository). Note: `yaml` format is not supported yet.

* `.github/worksflows/actions.yml`:

    - [Github Actions](https://docs.github.com/en/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](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token).

## Generated Arduino Library Doxygen Documenation

* [Online Doxygen HTML](https://erriez.github.io/ErriezGithubActionsPlatformIODoxygen/index.html)

* [Doxygen PDF](https://github.com/Erriez/ErriezGithubActionsPlatformIODoxygen/blob/gh-pages/ErriezTemplateLibrary.pdf)

## MIT License

This project is published under [MIT license](https://github.com/Erriez/ErriezGithubActionsPlatformIODoxygen/blob/main/LICENSE)

with an additional end user agreement (next section).

## End User Agreement :ukraine:

End users shall accept the [End User Agreement](https://github.com/Erriez/ErriezGithubActionsPlatformIODoxygen/blob/main/END_USER_AGREEMENT.md)

holding export restrictions to Russia to stop the WAR before using this project.