Skip to content

Commit 4ca6fa6

Browse files
authored
Merge pull request #1 from per1234/readme
Add readmes
2 parents a75af47 + 1d88df7 commit 4ca6fa6

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed

README.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Tooling Project Assets
2+
3+
The [Arduino](https://www.arduino.cc/) Tooling Team's collection of reusable project infrastructure assets.
4+
5+
## GitHub Actions workflow templates
6+
7+
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.
8+
9+
More information available [here](workflow-templates#readme).
10+
11+
## Security
12+
13+
If you think you found a vulnerability or other security-related bug in this repository's content, please read our
14+
[security policy](https://github.com/arduino/tooling-project-assets/security/policy) and report the bug to our Security Team 🛡️
15+
Thank you!
16+
17+
e-mail contact: [email protected]
18+
19+
## License
20+
21+
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/).

workflow-templates/README.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# GitHub Actions workflow templates
2+
3+
A collection of reusable [GitHub Actions workflows](https://docs.github.com/en/actions/quickstart#creating-your-first-workflow).
4+
5+
## Documentation
6+
7+
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:
8+
9+
- Instructions
10+
- List of asset files which must be added to the repository along with the workflow
11+
- Markup for status badges that can be added to the readme
12+
- Stock commit messages
13+
- Links to related workflows
14+
15+
## Workflow template strategy
16+
17+
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.
18+
19+
Addition of, or requests for, any additional workflows that can be reusable between several of the Arduino Tooling Team's repositories are welcome.
20+
21+
## GitHub Actions outages
22+
23+
**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.
24+
25+
## Dependabot
26+
27+
Dependabot is used to check for outdated action versions used in the workflow templates. Details about that are [here](dependabot/README.md).
28+
29+
The same can be done for the workflows of any repository. See the instructions [here](assets/dependabot/README.md).

0 commit comments

Comments
 (0)