-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add code of conduct, security, and repo tools. As well as github actions templates
- Loading branch information
1 parent
d025674
commit b8621ba
Showing
21 changed files
with
3,662 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# These are supported funding model platforms | ||
|
||
github: [OpenAir-Collective, ZanzyTHEbar, dahlwinters, madparker] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] | ||
patreon: # Replace with a single Patreon username | ||
open_collective: # Replace with a single Open Collective username | ||
ko_fi: openair-collective # Replace with a single Ko-Fi username | ||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel | ||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry | ||
liberapay: # Replace with a single Liberapay username | ||
issuehunt: # Replace with a single IssueHunt username | ||
otechie: # Replace with a single Otechie username | ||
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry | ||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
--- | ||
name: Problem Report | ||
about: Create a Report to help us improve | ||
--- | ||
|
||
<!-- Thanks for reporting a problem for this project. READ THIS FIRST: | ||
This issue template is meant to REPORT Cyan software PROBLEMS ONLY | ||
Please DO NOT OPEN AN ISSUE: | ||
- If your Cyan version is not the latest from the development branch, please update your device before submitting your issue. Your problem might already be solved. The latest precompiled binaries of Cyan can be downloaded from https://openair-collective.github.io/openair-cyan/OTA/ | ||
- If your issue is a flashing issue, please address it to the [Cyan Support Chat](https://openair-collective.github.io/openair-cyan/contact/) | ||
- If your issue is compilation problem, please address it to the [Cyan Support Chat](https://openair-collective.github.io/openair-cyan/contact/) | ||
- If your issue has been addressed before (i.e., duplicated issue), please ask in the original issue | ||
- If your issue is a Wi-Fi problem or MQTT problem, please try the steps provided in the [FAQ](https://openair-collective.github.io/openair-cyan/FAQ) and [Troubleshooting](https://openair-collective.github.io/openair-cyan/contact/Troubleshooting) | ||
Please take a few minutes to complete the requested information below. Our ability to provide assistance is greatly hampered without it. The details requested potentially affect which options to pursue. The small amount of time you spend completing the template will also help the volunteers providing the assistance to you to reduce the time required to help you. | ||
DO NOT DELETE ANY TEXT from this template! Otherwise the issue will be auto-closed. | ||
--> | ||
|
||
### PROBLEM DESCRIPTION | ||
|
||
_A clear and concise description of what the problem is._ | ||
|
||
### REQUESTED INFORMATION | ||
|
||
_Make sure your have performed every step and checked the applicable boxes before submitting your issue. Thank you!_ | ||
|
||
- [ ] Read the [Contributing Guide and Policy](https://github.com/openair-collective/openair-cyan/tree/docs/CONTRIBUTING.md) and [the Code of Conduct](https://github.com/openair-collective/openair-cyan/tree/docs/CODE_OF_CONDUCT.md) | ||
- [ ] Searched the problem in [issues](https://github.com/openair-collective/openair-cyan/issues) | ||
- [ ] Searched the problem in [discussions](https://github.com/openair-collective/openair-cyan/discussions) | ||
- [ ] Searched the problem in the [docs](https://openair-collective.github.io/openair-cyan/FAQ) | ||
- [ ] Searched the problem in the [chat](https://openair-collective.github.io/openair-cyan/contact/) | ||
- [ ] Device used (e.g., ESP32-WROOM-d): _____ | ||
- [ ] Cyan binary firmware version number used: _____ | ||
- [ ] Pre-compiled | ||
- [ ] Self-compiled | ||
- [ ] Flashing tools used: _____ | ||
- [ ] Provide the output of command: `Backlog Template; Module; GPIO 255`: | ||
|
||
```lua | ||
Configuration output here: | ||
|
||
|
||
``` | ||
|
||
- [ ] If using rules, provide the output of this command: `Backlog Rule1; Rule2; Rule3`: | ||
|
||
```lua | ||
Rules output here: | ||
|
||
|
||
``` | ||
|
||
- [ ] Provide the output of this command: `Status 0`: | ||
|
||
```lua | ||
STATUS 0 output here: | ||
|
||
|
||
``` | ||
|
||
- [ ] Set `weblog` to 4 and then, when you experience your issue, provide the output of the Console log: | ||
|
||
```lua | ||
Console output here: | ||
|
||
|
||
``` | ||
|
||
### TO REPRODUCE | ||
|
||
_Steps to reproduce the behavior:_ | ||
|
||
### EXPECTED BEHAVIOUR | ||
|
||
_A clear and concise description of what you expected to happen._ | ||
|
||
### SCREENSHOTS | ||
|
||
_If applicable, add screenshots to help explain your problem._ | ||
|
||
### ADDITIONAL CONTEXT | ||
|
||
_Add any other context about the problem here._ | ||
|
||
**(Please, remember to close the issue when the problem has been addressed)** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Cyan Docs | ||
url: https://openair-collective.github.io/openair-cyan/ | ||
about: All the information related to Cyan. | ||
- name: Cyan Discussions and Support | ||
url: https://github.com/openair-collective/openair-cyan/discussions | ||
about: Cyan usage Questions, Feature Requests and Projects. | ||
- name: Cyan Users Chat | ||
url: https://openair-collective.github.io/openair-cyan/comments_suggetions/ | ||
about: Chat for feedback, questions and troubleshooting. | ||
- name: Cyan Discord | ||
url: https://openair-collective.github.io/openair-cyan/contact/ | ||
about: Chat for feedback, questions and troubleshooting. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Description | ||
|
||
**Related issue (if applicable):** fixes #<Cyan issue number goes here> | ||
|
||
## Checklist | ||
|
||
- [ ] The pull request is done against the latest development branch | ||
- [ ] Only relevant files were touched | ||
- [ ] Only one feature/fix was added per PR and the code change compiles without warnings | ||
- [ ] The code change is tested and works with Cyan core ESP32 board X newest release | ||
- [ ] The code change is tested and works with Cyan core Arduino board X newest release | ||
- [ ] The code change is tested and works with Cyan core Adafruit board X newest release | ||
- [ ] I accept the [CLA](https://github.com/openair-collective/openair-cyan/tree/docs/CONTRIBUTING.md#contributor-license-agreement-cla). | ||
|
||
_NOTE: The code change must pass CI tests. **Your PR cannot be merged unless tests pass**_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Configuration for sentiment-bot - https://github.com/behaviorbot/sentiment-bot | ||
|
||
# *Required* toxicity threshold between 0 and .99 with the higher numbers being the most toxic | ||
# Anything higher than this threshold will be marked as toxic and commented on | ||
sentimentBotToxicityThreshold: .7 | ||
|
||
# *Required* Comment to reply with | ||
sentimentBotReplyComment: > | ||
Please be sure to review the code of conduct and be respectful of other users. | ||
# Note: the bot will only work if your repository has a Code of Conduct |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# CLOSE ISSUE BOT | ||
# --------------- | ||
# A bot which helps you to close issues that don't include some specific contents. | ||
# See how to use it in https://github.com/offu/close-issue-app. | ||
|
||
# Comment that will be sent if an issue is judged to be closed. | ||
comment: >- | ||
This issue has been automatically closed because the PROBLEM REPORT TEMPLATE is missing or incomplete. | ||
Filling the template is required so standard questions don't need to be asked again each time. | ||
Our ability to provide assistance is greatly hampered if few minutes are not taken to complete the issue template | ||
with the requested information. The details requested potentially affect which options to pursue. The small amount | ||
of time you will spend completing the template will also help the volunteers, providing assistance to you, to reduce | ||
the time required to help you. | ||
Please, could you be so kind on completing the [PROBLEM REPORT TEMPLATE](https://github.com/openair-collective/openair-cyan/issues/new/choose) in order to have more information so as to properly help you? | ||
Thank you for taking the time to report, hopefully it can be resolved soon. | ||
[Discussions](https://github.com/openair-collective/openair-cyan/discussions) for Questions, Feature Requests and Projects. | ||
[Chat](https://discord.gg/Bz52xHvZ3c) for more users experience. | ||
Please check the [Code of Conduct](https://github.com/openair-collective/openair-cyan/tree/docs/CODE_OF_CONDUCT.md) and the [Contributing Guideline and Policy](https://github.com/openair-collective/tree/docs/openair-cyan/CONTRIBUTING.md) | ||
issueConfigs: | ||
# There can be several configs for different kind of issues. | ||
- content: | ||
# template 1: bug report | ||
- "PROBLEM DESCRIPTION" | ||
- "REQUESTED INFORMATION" | ||
- "TO REPRODUCE" | ||
- "EXPECTED BEHAVIOUR" | ||
- content: | ||
# template 2: feature request | ||
- "Have you looked for this feature in other issues and in the docs" | ||
- "Describe the solution you'd like" | ||
|
||
# Optional configuration: | ||
# | ||
# whether the keywords are case-insensitive | ||
# default value is false, which means keywords are case-sensitive | ||
caseInsensitive: true | ||
# the label that will be added when the bot close an issue | ||
# The bot will only add a label if this property is set. | ||
label: "template missing/incomplete" | ||
# The issue is judged to be legal if it includes all keywords from any of these two configs. | ||
# Or it will be closed by the app. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Instructions | ||
|
||
Please rename the `.github/workflows/<name>.txt` file of the workflow you wish to enable to `.github/workflows/<name>.yml`. | ||
|
||
This file should be formatted as YAML, feel free to change the variables in the file. Please follow the [workflow documentation](https://docs.github.com/en/actions) for more information. [Learn more about workflows](https://docs.github.com/en/actions/using-workflows). | ||
|
||
Please note that the workflows will be enabled automatically after you push your changes to the repository, and can always be enabled manually from the `Workflows` section of the repository settings. | ||
|
||
Please ***do not delete*** the `.github/workflows/<name>.txt` files, and do not delete the `.github/workflows/build-jekyll.yml` file. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
name: Build and Deploy to Github Pages | ||
|
||
on: | ||
push: | ||
branches: [docs] | ||
|
||
# Allows you to run this workflow manually from the Actions tab | ||
workflow_dispatch: | ||
|
||
jobs: | ||
build_and_deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
|
||
# Use GitHub Actions' cache to cache dependencies on servers | ||
- uses: actions/cache@v2 | ||
with: | ||
path: vendor/bundle | ||
key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }} | ||
restore-keys: | | ||
${{ runner.os }}-gems- | ||
# Use GitHub Deploy Action to build and deploy to Github | ||
- uses: jeffreytse/jekyll-deploy-action@v0.3.1 | ||
with: | ||
provider: 'github' | ||
token: ${{ secrets.GITHUB_TOKEN }} # It's your Personal Access Token(PAT) | ||
jekyll_src: './docs' # Default is root directory |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
name: Tasmota CI | ||
|
||
on: | ||
workflow_dispatch: | ||
pull_request: | ||
branches: development | ||
paths: | ||
- '**.c' | ||
- '**.cpp' | ||
- '**.h' | ||
- '**.hpp' | ||
- '**.ino' | ||
- '**.json' | ||
- '**.properties' | ||
- 'pio-tools/*.py' | ||
- '**.ini' | ||
- '.github/workflows/build_all_the_things.yml' | ||
|
||
jobs: | ||
base-images: | ||
runs-on: ubuntu-latest | ||
if: github.repository == 'arendst/Tasmota' | ||
strategy: | ||
matrix: | ||
variant: | ||
- tasmota | ||
- tasmota4M | ||
- tasmota-display | ||
- tasmota-ir | ||
- tasmota-knx | ||
- tasmota-lite | ||
- tasmota-minimal | ||
- tasmota-sensors | ||
- tasmota-zbbridge | ||
- tasmota-zigbee | ||
- tasmota32 | ||
- tasmota32-webcam | ||
- tasmota32-bluetooth | ||
- tasmota32-core2 | ||
- tasmota32-display | ||
- tasmota32-ir | ||
- tasmota32-lvgl | ||
- tasmota32s2 | ||
- tasmota32c3 | ||
- tasmota32c3usb | ||
- tasmota32solo1 | ||
- tasmota32solo1-safeboot | ||
- tasmota32-safeboot | ||
- tasmota32c3-safeboot | ||
- tasmota32c3usb-safeboot | ||
- tasmota32s2-safeboot | ||
- tasmota32s3-safeboot | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Set up Python | ||
uses: actions/setup-python@v1 | ||
- name: Install dependencies | ||
run: | | ||
#python -m pip install --upgrade pip | ||
pip install -U platformio | ||
#platformio upgrade --dev | ||
#platformio update | ||
- name: Run PlatformIO | ||
run: platformio run -e ${{ matrix.variant }} | ||
- uses: actions/upload-artifact@v2 | ||
with: | ||
name: firmware | ||
path: ./build_output | ||
|
||
language-images: | ||
runs-on: ubuntu-latest | ||
if: github.repository == 'arendst/Tasmota' | ||
strategy: | ||
matrix: | ||
variant: [ tasmota ] | ||
language: [ AF, BG, BR, CN, CZ, DE, ES, FR, FY, GR, HE, HU, IT, KO, NL, PL, PT, RO, RU, SE, SK, TR, TW, UK, VN ] | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Set up Python | ||
uses: actions/setup-python@v1 | ||
- name: Install dependencies | ||
run: | | ||
#python -m pip install --upgrade pip | ||
pip install -U platformio | ||
#platformio upgrade --dev | ||
#platformio update | ||
- name: Run PlatformIO | ||
run: platformio run -e ${{ matrix.variant }}-${{ matrix.language }} | ||
- uses: actions/upload-artifact@v2 | ||
with: | ||
name: firmware | ||
path: ./build_output |
Oops, something went wrong.