chore(ci): try using more global defined .github options
This commit is contained in:
kjeld Schouten-Lebbing
@@ -1,65 +0,0 @@
|
||||
# Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering a open and productive environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, sex characteristics, gender, level of experience,
|
||||
education, socio-economic status, nationality, personal appearance, race,
|
||||
religion, or sexual identity and orientation.
|
||||
|
||||
## Our Rules
|
||||
|
||||
We are a dedicated bunch of people, working on Community Apps for TrueNAS SCALE.
|
||||
|
||||
1. Keep the chat somewhat friendly - You can be an jerk, just don't go on a rampage.
|
||||
2. Keep things on-topic and arguments to designated channels - Check channel descriptions and pins for channel-specific rules
|
||||
3. No trolling - This includes feigning idiocy and “shitposting”. Keeping chat light-hearted and fun is one thing. However, moronic behavior, false information and shitposting will not be tolerated.
|
||||
4. No spamming - No link, text, or ASCII spam; no giant walls of text/links; and no all CAPS posts.
|
||||
5. No NSFW/NSFL content outside of designated channels- This includes your avatar.
|
||||
6. Use appropriate usernames - No blank names, no long names, no URLs, no emojis and no character breaking names.
|
||||
7. No begging - This includes soft begging.
|
||||
8. No advertising - No referral links. No buying/selling/trading.
|
||||
9. Comply to the platform ToS and Community Guidelines
|
||||
10. If you ask for support, please always add as much information as you can - Screenshots, Logs etc. are needed to help you!
|
||||
11. We expect some basic research first. Specifically: try to find related information in our Announcements, our Docs, the TrueNAS forum and/or TrueNAS Docs.
|
||||
12. Keep personal feedback private. Got issues with someone? Send them a private message instead!
|
||||
13. Encounter an App not working as expected? You can directly file a bug on our Github, no need to verify with anyone!
|
||||
|
||||
If you see something against the rules or something that makes you feel unsafe, let the Moderators know or us the contact information under `Enforcement`.
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers and moderators are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers and moderators have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team at moderation@truecharts.org. All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. The project team is
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
## Appeal
|
||||
|
||||
Everyone has the right to appeal a Ban decision. Appeals can be submitted by contacting the project team at appeals@truecharts.org
|
||||
Appeals will always be processed by a maintainer or moderator that was not involved in the original decision or, in case all moderators where involved, by a majority decision of staff.
|
||||
@@ -1,77 +0,0 @@
|
||||
# Contribution Guidelines
|
||||
|
||||
This project welcomes any and all input, but we need to have a few quality guidelines. These guidelines will be examplained here, in this document.
|
||||
|
||||
### GIT Guidelines
|
||||
***
|
||||
#### New to GIT
|
||||
|
||||
If you have never used git before, you can look up our general reference on our wiki.
|
||||
|
||||
#### Git and You
|
||||
|
||||
GIT is a fantastic system, but while using it we have a few guidelines to keep it fantastic for everyone.
|
||||
|
||||
* Submit complete PR's.
|
||||
* Add [DNM] if you do not want your PR merged yet.
|
||||
* Always try and fill in the whole form, even for small PR's.
|
||||
* Don't close when a reviewer requests changes (just push the changes or ask for help).
|
||||
* Explain what you did in your PR.
|
||||
* Be thorough.
|
||||
* If you can add screenshots to clarify.
|
||||
* Always try to add "Fixes #000" (where 000 is the Issue your PR fixes)
|
||||
* found something you want to fix yourself? Please do make an issue too.
|
||||
|
||||
### Structure Guidelines
|
||||
***
|
||||
|
||||
#### Inclusion of files and folders
|
||||
|
||||
Although GIT is quite friendly in what it accepts in terms of files and folder changes in a commit, a reviewer's or bugfixer's time is not unlimited. For that reason, we have a few specific guidelines in regards to the inclusion of files and folders in your PR.
|
||||
|
||||
* Only include files you actually changed.
|
||||
* Try not to include multiple changes in one PR
|
||||
* Want to change the formatting of multiple files too? Make a separate PR.
|
||||
|
||||
|
||||
### Code Guidelines
|
||||
***
|
||||
#### Your code, your style, my review
|
||||
|
||||
Here at TrueCharts, we value people having their own style. But your code needs to be reviewable and editable by others too. For that reason, we have a few basic coding guidelines
|
||||
|
||||
* **Always** explain regex in a comment within your code.
|
||||
* Write simple code and don't try to impress.
|
||||
* We will run (Basic) automated reformating of code once in a while.
|
||||
* Document your changes in your code and if need be, on the wiki.
|
||||
* All PR's should be able to pass our automated tests.
|
||||
|
||||
#### Apps requirements
|
||||
|
||||
- Apps should always save user-specific data in a persistant location. That can be connected by both IXVolume or Hostpath
|
||||
- Apps should not require the user to edit any config file themselves. All config changes should be either automated or using the UI
|
||||
- Apps should not use default passwords, the user should always be forced(!) to put credentials in manually
|
||||
|
||||
|
||||
### Review Guidelines
|
||||
***
|
||||
Even us review gods need some guidelines once in a while.
|
||||
|
||||
* Let people learn from their mistakes
|
||||
* Review instead of merging without comments
|
||||
* Abide by these guidelines in your review
|
||||
* Tests exist for a reason. Don't merge with test-failures
|
||||
|
||||
|
||||
|
||||
### Todo vs Feature vs bug:
|
||||
***
|
||||
Please take note of the difference between a TODO and Feature
|
||||
|
||||
* Bug: An unexpected behavior of the script or a crash. Including, but not limited to, errors and warnings.
|
||||
* Todo: When you come across something that needs tweaking/adding during development, is not an unexpected behavior
|
||||
* Feature: When you, out of personal preference, want something added or changed.
|
||||
|
||||
### That's it!
|
||||
***
|
||||
Someone will come along and review the changes. If everything looks good then they will merge it with the main repo. If you need any help don't be afraid to ask in the discord channel: [https://discord.gg/tFcTpBp](https://discord.gg/tFcTpBp)
|
||||
@@ -1,12 +0,0 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: Ornias1993 # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
|
||||
patreon: truecharts # Replace with a single Patreon username
|
||||
open_collective: # Replace with a single Open Collective username
|
||||
ko_fi: ornias # 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
|
||||
custom: https://bunq.me/truecharts
|
||||
@@ -1,37 +0,0 @@
|
||||
name: 📃 App Request 🙏
|
||||
description: Request new apps to be added to TrueCharts Catalog
|
||||
title: "[Add]: "
|
||||
labels: ["New App Request", "backlog"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for making this request.
|
||||
Keep in mind that this request is not a guarantee that the app will be added.
|
||||
|
||||
---
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Short description of the app
|
||||
description: Describe what the app does in a few words
|
||||
placeholder: Ex. An online platform to share your code.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Sources
|
||||
description: |
|
||||
Provide source links for the app.
|
||||
Like documentation, github repo, container image, etc
|
||||
validations:
|
||||
required: true
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: I've read and agree with the following
|
||||
options:
|
||||
- label: I've checked all open and closed issues and my request is not there.
|
||||
required: true
|
||||
- label: I've checked all open and closed pull requests and my request is not there.
|
||||
required: true
|
||||
- label: I've checked the [website](https://truecharts.org/apps/app-requests/) and my request is not there.
|
||||
required: true
|
||||
@@ -1,128 +0,0 @@
|
||||
name: ⚙️ Bug Report 🪛
|
||||
description: Request new apps to be added to TrueCharts Catalog
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for making this bug report.
|
||||
|
||||
⚠️ Mind your title. ⚠️
|
||||
|
||||
- "App stuck in deploying state" - Is not the title/description of your actual bug.
|
||||
- "Appname not working" - Is not the title/description of your actual bug.
|
||||
- Don't refer version in title.
|
||||
|
||||
---
|
||||
|
||||
- type: input
|
||||
id: app-name
|
||||
attributes:
|
||||
label: App Name
|
||||
description: |
|
||||
The name of the app having the issue.
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: os-version
|
||||
attributes:
|
||||
label: SCALE Version
|
||||
description: |
|
||||
The version of truenas scale you are currently running.
|
||||
FOUND IN: System Settings > General > OS Version
|
||||
multiple: false
|
||||
options:
|
||||
- "22.02.0"
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: app-version
|
||||
attributes:
|
||||
label: App Version
|
||||
description: |
|
||||
The version of the app having the issue and versions of any apps being used in conjunction.
|
||||
FOUND IN: Apps > Installed Applications
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: app-events
|
||||
attributes:
|
||||
label: Application Events
|
||||
description: |
|
||||
Debug information from the app(s) specifically
|
||||
FOUND IN: Apps > Installed Applications > (Click on the app name) > Click the caret next to application events and include a screenshot here.
|
||||
render: Shell
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: app-logs
|
||||
attributes:
|
||||
label: Application Logs
|
||||
description: |
|
||||
Log output from the containers involved in the app
|
||||
FOUND IN: Apps > Installed Applications > (Click the 3 dots on the top right of the app box) > Logs
|
||||
Open the logs for each pod used for the app and copy/paste here.
|
||||
|
||||
Note: It can take a moment for the logs to show on the logs screen.
|
||||
render: Shell
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: app-config
|
||||
attributes:
|
||||
label: Application Configuration
|
||||
description: |
|
||||
The configuration settings for the app (Make sure to include what you have changed AND what you didn't change).
|
||||
If possible use the edit features in your screenshot tool to highlight the portions you changed intentionally.
|
||||
FOUND IN: Apps > Installed Applications > (Click the 3 dots on the top right of the app box) > Edit
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: bug-report
|
||||
attributes:
|
||||
label: Describe the bug
|
||||
description: A clear and concise description of what the bug is.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: repro-steps
|
||||
attributes:
|
||||
label: To Reproduce
|
||||
description: |
|
||||
Make sure that if you follow these steps again yourself the bug happens again. If it doesn't it's Probably a configuration error and should be handled with a support ticket on the discord.
|
||||
Steps to reproduce the behavior:
|
||||
placeholder: |
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: exp-behaviour
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: A clear and concise description of what you expected to happen.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: screenshots
|
||||
attributes:
|
||||
label: Screenshots
|
||||
description: If applicable, add screenshots to help explain your problem.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: add-contaxt
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Add any other context about the problem here.
|
||||
validations:
|
||||
required: true
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: I've read and agree with the following
|
||||
options:
|
||||
- label: I've checked all open and closed issues and my issue is not there.
|
||||
required: true
|
||||
@@ -1 +0,0 @@
|
||||
blank_issues_enabled: false
|
||||
@@ -1,43 +0,0 @@
|
||||
name: ⚙️ Feature or Enhancement Request 🙏
|
||||
description: Suggest an idea for TrueCharts
|
||||
labels: ["enhancement"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for making this suggestion.
|
||||
|
||||
---
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Is your feature request related to a problem?
|
||||
description: A clear and concise description of what the problem is.
|
||||
placeholder: Ex. I'm always frustrated when [...]
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Describe the solution you'd like
|
||||
description: A clear and concise description of what you want to happen.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Describe alternatives you've considered
|
||||
description: A clear and concise description of any alternative solutions or features you've considered.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: Add any other context or screenshots about the feature request here.
|
||||
validations:
|
||||
required: false
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: I've read and agree with the following
|
||||
options:
|
||||
- label: I've checked all open and closed issues and my request is not there.
|
||||
required: true
|
||||
- label: I've checked all open and closed pull requests and my request is not there.
|
||||
required: true
|
||||
@@ -1,30 +0,0 @@
|
||||
**Description**
|
||||
<!--
|
||||
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
|
||||
-->
|
||||
⚒️ Fixes # <!--(issue)-->
|
||||
|
||||
**⚙️ Type of change**
|
||||
|
||||
- [ ] ⚙️ Feature/App addition
|
||||
- [ ] 🪛 Bugfix
|
||||
- [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
||||
- [ ] 🔃 Refactor of current code
|
||||
|
||||
**🧪 How Has This Been Tested?**
|
||||
<!--
|
||||
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
|
||||
-->
|
||||
|
||||
**📃 Notes:**
|
||||
<!-- Please enter any other relevant information here -->
|
||||
|
||||
**✔️ Checklist:**
|
||||
|
||||
- [ ] ⚖️ My code follows the style guidelines of this project
|
||||
- [ ] 👀 I have performed a self-review of my own code
|
||||
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas
|
||||
- [ ] 📄 I have made corresponding changes to the documentation
|
||||
- [ ] ⚠️ My changes generate no new warnings
|
||||
- [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works
|
||||
- [ ] ⬆️ I increased versions for any altered app according to semantic versioning
|
||||
@@ -1,34 +0,0 @@
|
||||
# Security Policy
|
||||
|
||||
## Supported Versions of TrueNAS SCALE
|
||||
|
||||
Our focus will always be on the latest version of TrueNAS SCALE.
|
||||
However: We might provide extended support to older versions of TrueNAS SCALE as depicted in our Support Policy
|
||||
|
||||
|
||||
## CVE's and you
|
||||
|
||||
When we build our own containers, we aim not to have any non-mitigated high or critical CVE's present. For the containers made by others, we aim to use the most secure container available, but we cannot guarantee they keep to the same high safetly standards as we do.
|
||||
|
||||
|
||||
## Response timeframe
|
||||
|
||||
The safety of our users is our prime concerns. We therefore aim to respond to any issues within 24 hours.
|
||||
|
||||
Though we hope that such situations will never happen, we will, in the most dire of circumstances, not hesitate with agressive responses to fix issues. This includes completely locking down/removing certain Apps or portions of the project from being installed.
|
||||
|
||||
|
||||
## Compliance
|
||||
|
||||
As project owner is located in the Netherlands, we need to comply to all legal requirements and lawfull orders from the Government of the Netherlands.
|
||||
|
||||
**As of Today we have not recieved any data requests from the Dutch Government, that we are forbiden to make public. **
|
||||
|
||||
We are required to be fully GDPR compliant and fall under the sole authority of the Dutch Privacy Authority when it comes to GDPR compliance.
|
||||
|
||||
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
If you find any security issue, please email the project directly:
|
||||
info@truecharts.org
|
||||
@@ -1,15 +0,0 @@
|
||||
# Support Policy
|
||||
|
||||
TrueCharts aims to always support the lastest version of TrueNAS SCALE.
|
||||
However, sometimes new versions of either TrueNAS or TrueCharts introduces breaking changes.
|
||||
This document highlights which versions of TrueCharts (or rather branches), support which versions of TrueNAS SCALE.
|
||||
|
||||
We also document which versions of TrueNAS will recieve TrueCharts updates and for which versions we are accepting bug reports.
|
||||
|
||||
## Supported Versions
|
||||
|
||||
| TrueNAS version | Branch| Supported with updates | Accepting Support tickets | Accepting Bugreports | Notes |
|
||||
| ------- | ------- |------------------ | -------------- | -------------- | -------------- |
|
||||
| 22.02 RC | `master` | :white_check_mark: | :x: | :x: | Adviced to update to 22.02 RELEASE
|
||||
| 22.02 RELEASE | `master` | :white_check_mark: | :white_check_mark: | :white_check_mark: | Most Stable Release
|
||||
| Nightly | `master` | :white_check_mark: | :x: | :white_check_mark: | Please only submit bugreports during codefreeze
|
||||
@@ -0,0 +1,47 @@
|
||||
name: "Pull Request: Validate"
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.head_ref }}-pr-validate
|
||||
# cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
#pr-metadata:
|
||||
# uses: truecharts/.github/workflows/pr-metadata.yaml@master
|
||||
#
|
||||
pre-commit-check:
|
||||
uses: truecharts/.github/workflows/pre-commit-check.yaml@master
|
||||
# needs:
|
||||
# - pr-metadata
|
||||
with:
|
||||
modifiedFiles: ${{ needs.pr-metadata.outputs.addedOrModifiedFiles }}
|
||||
|
||||
#charts-changelog:
|
||||
# uses: truecharts/.github/workflows/charts-changelog.yaml@master
|
||||
# needs:
|
||||
# - pr-metadata
|
||||
# - pre-commit-check
|
||||
# with:
|
||||
# isRenovatePR: ${{ needs.pr-metadata.outputs.isRenovatePR }}
|
||||
# modifiedCharts: ${{ needs.pr-metadata.outputs.addedOrModifiedCharts }}
|
||||
|
||||
charts-lint:
|
||||
uses: truecharts/.github/workflows/charts-lint.yaml@master
|
||||
#needs:
|
||||
# - pr-metadata
|
||||
# - charts-changelog
|
||||
with:
|
||||
checkoutCommit: ${{ needs.charts-changelog.outputs.commitHash }}
|
||||
chartChangesDetected: ${{ needs.pr-metadata.outputs.addedOrModified }}
|
||||
|
||||
charts-test:
|
||||
uses: truecharts/.github/workflows/charts-test.yaml@master
|
||||
needs:
|
||||
# - pr-metadata
|
||||
# - charts-changelog
|
||||
- charts-lint
|
||||
with:
|
||||
checkoutCommit: ${{ needs.charts-changelog.outputs.commitHash }}
|
||||
chartChangesDetected: ${{ needs.pr-metadata.outputs.addedOrModified }}
|
||||
Reference in New Issue
Block a user