mirror of
https://github.com/truenas/charts.git
synced 2026-07-17 03:51:41 +08:00
NAS-121003 / 23.10 / Adapt charts CI and improve/fix common (#1011)
* Adapt charts CI and improve/fix common * add check on permissions contaienr * add postgres template * update comments * Update create_app.sh * add check * update script * auto gen item.yaml from Chart,yaml * rename readme on dest * duplicate readme from the same source * correct comment * reoder * remove extra space * keep both README and app-readme * update regex, to also allow 2 letter names, which is also valid * No need to check host network if there aren't any pod values * use same pattern as the pod.name label (not prepending release-name * update deps * add chart dirs to ci * Add a validation to check if there is any yaml errors after merging files * update charts path on ci * common/1.0.0/ -> common/ * update common-test dep path * temp update create_app script * make permissions container name configurable, incase we want to change order of execution * update naming convention * fix typo and a missed name change * do not allow `--` in names
This commit is contained in:
41
library/common/docs/notes.md
Normal file
41
library/common/docs/notes.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Notes
|
||||
|
||||
| Key | Type | Required | Helm Template | Default | Description |
|
||||
| :----------- | :------: | :------: | :-----------: | :-------: | :------------------------------------------------------- |
|
||||
| notes | `dict` | ❌ | ❌ | See below | Define values for NOTES.txt |
|
||||
| notes.header | `string` | ❌ | ✅ | See below | Define header |
|
||||
| notes.custom | `string` | ❌ | ✅ | See below | Define custom message, this go between header and footer |
|
||||
| notes.footer | `string` | ❌ | ✅ | See below | Define footer |
|
||||
|
||||
---
|
||||
|
||||
Appears in:
|
||||
|
||||
- `.Values.notes`
|
||||
|
||||
---
|
||||
|
||||
Default:
|
||||
|
||||
```yaml
|
||||
notes:
|
||||
header: |
|
||||
# Welcome to SCALE
|
||||
Thank you for installing <{{ .Chart.Name }}>.
|
||||
custom: ""
|
||||
footer: |
|
||||
# Documentation
|
||||
Documentation for this chart can be found at ...
|
||||
# Bug reports
|
||||
If you find a bug in this chart, please file an issue at ...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
Examples:
|
||||
|
||||
```yaml
|
||||
notes:
|
||||
custom: |
|
||||
This is a custom message
|
||||
```
|
||||
Reference in New Issue
Block a user