Skip to content

Add readmes #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Tooling Project Assets

The [Arduino](https://www.arduino.cc/) Tooling Team's collection of reusable project infrastructure assets.

## GitHub Actions workflow templates

The [`workflow-templates` folder](workflow-templates) contains a collection of [GitHub Actions workflows](https://docs.github.com/en/actions/quickstart#creating-your-first-workflow) which can be used in any applicable repository either as-is or with minor project-specific configuration.

More information available [here](workflow-templates#readme).

## Security

If you think you found a vulnerability or other security-related bug in this repository's content, please read our
[security policy](https://github.com/arduino/tooling-project-assets/security/policy) and report the bug to our Security Team 🛡️
Thank you!

e-mail contact: [email protected]

## License

Unless stated otherwise in the individual file or subfolder, the contents of this repository are in the public domain, as defined by the [CC0 1.0 Universal license](https://creativecommons.org/publicdomain/zero/1.0/).
29 changes: 29 additions & 0 deletions workflow-templates/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# GitHub Actions workflow templates

A collection of reusable [GitHub Actions workflows](https://docs.github.com/en/actions/quickstart#creating-your-first-workflow).

## Documentation

While some workflows can be added to any repository without any modification, others need to be configured for each project. "TODO" comments in the workflow explain what needs to be done. Documentation for each workflow is provided by the .md file of the same name, including:

- Instructions
- List of asset files which must be added to the repository along with the workflow
- Markup for status badges that can be added to the readme
- Stock commit messages
- Links to related workflows

## Workflow template strategy

Whenever possible, these workflows should be used as the models when setting up GitHub Actions in a repository, rather than sourcing equivalent, possibly outdated, workflows from a random repository. If fixes or improvements are discovered, please push them back here to the workflow templates, from whence they can propagate to all other repositories.

Addition of, or requests for, any additional workflows that can be reusable between several of the Arduino Tooling Team's repositories are welcome.

## GitHub Actions outages

**Note**: GitHub Actions periodically has outages which result in workflow failures unrelated to any problems with the contents of the repository or actions used by the workflow. In this event, the workflows will start passing again once the service recovers.

## Dependabot

Dependabot is used to check for outdated action versions used in the workflow templates. Details about that are [here](dependabot/README.md).

The same can be done for the workflows of any repository. See the instructions [here](assets/dependabot/README.md).