chore(forgejo-runner): doc syntax

This commit is contained in:
WrenIX 2024-11-20 23:24:36 +01:00
parent dde49d45cd
commit 4604e5fe6d
Signed by: wrenix
GPG key ID: 7AFDB012974B1BB5
4 changed files with 25 additions and 13 deletions

View file

@ -2,9 +2,9 @@
= forgejo-runner = forgejo-runner
image::https://img.shields.io/badge/Version-0.4.0-informational?style=flat-square[Version: 0.4.0] image::https://img.shields.io/badge/Version-0.4.1-informational?style=flat-square[Version: 0.4.1]
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application] image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
image::https://img.shields.io/badge/AppVersion-5.0.0-informational?style=flat-square[AppVersion: 5.0.0] image::https://img.shields.io/badge/AppVersion-5.0.1-informational?style=flat-square[AppVersion: 5.0.1]
== Maintainers == Maintainers
.Maintainers .Maintainers
@ -16,12 +16,15 @@ image::https://img.shields.io/badge/AppVersion-5.0.0-informational?style=flat-sq
| <https://wrenix.eu> | <https://wrenix.eu>
|=== |===
== Accessing docker socket inside job containers {{< callout type="warning" >}}
Me, wrenix, switch to woodpecker and maybe does not test every change.
{{< /callout >}}
## Accessing docker socket inside job containers
To access the docker socket inside the job containers, the following example values may be used (see `values-dind-bypass.yaml`): To access the docker socket inside the job containers, the following example values may be used (see `values-dind-bypass.yaml`):
[source,yaml] ``` yaml {filename="values.yaml"}
----
runner: runner:
config: config:
create: true create: true
@ -46,7 +49,7 @@ runner:
valid_volumes: valid_volumes:
- /certs/client - /certs/client
---- ```
== Usage == Usage

View file

@ -7,7 +7,7 @@ description: "Deploy runner for an forgejo instance (default codeberg.org)"
# forgejo-runner # forgejo-runner
![Version: 0.4.0](https://img.shields.io/badge/Version-0.4.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 5.0.0](https://img.shields.io/badge/AppVersion-5.0.0-informational?style=flat-square) ![Version: 0.4.1](https://img.shields.io/badge/Version-0.4.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 5.0.1](https://img.shields.io/badge/AppVersion-5.0.1-informational?style=flat-square)
Deploy runner for an forgejo instance (default codeberg.org) Deploy runner for an forgejo instance (default codeberg.org)
@ -17,12 +17,15 @@ Deploy runner for an forgejo instance (default codeberg.org)
| ---- | ------ | --- | | ---- | ------ | --- |
| WrenIX | | <https://wrenix.eu> | | WrenIX | | <https://wrenix.eu> |
== Accessing docker socket inside job containers {{< callout type="warning" >}}
Me, wrenix, switch to woodpecker and maybe does not test every change.
{{< /callout >}}
## Accessing docker socket inside job containers
To access the docker socket inside the job containers, the following example values may be used (see `values-dind-bypass.yaml`): To access the docker socket inside the job containers, the following example values may be used (see `values-dind-bypass.yaml`):
[source,yaml] ``` yaml {filename="values.yaml"}
----
runner: runner:
config: config:
create: true create: true
@ -47,7 +50,7 @@ runner:
valid_volumes: valid_volumes:
- /certs/client - /certs/client
---- ```
## Usage ## Usage

View file

@ -1,8 +1,9 @@
{{ define "chart.prerequirements" -}} {{ define "chart.prerequirements" -}}
{{`
{{< callout type="warning" >}} {{< callout type="warning" >}}
Me, wrenix, switch to woodpecker and maybe does not test every change. Me, wrenix, switch to woodpecker and maybe does not test every change.
{{< /callout >}} {{< /callout >}}
`}}
## Accessing docker socket inside job containers ## Accessing docker socket inside job containers
To access the docker socket inside the job containers, the following example values may be used (see `values-dind-bypass.yaml`): To access the docker socket inside the job containers, the following example values may be used (see `values-dind-bypass.yaml`):

View file

@ -40,7 +40,8 @@ for p in * ; do
if [ "$tag" == "$lastTag" ]; then if [ "$tag" == "$lastTag" ]; then
echo "changed helmchart should create new pkg - diff line count has:" echo "changed helmchart should create new pkg - diff line count has:"
echo $(git diff "${lastTag}" -- "${p}" | wc -l); echo $(git diff "${lastTag}" -- "${p}" | wc -l);
exit 1 echo
continue;
fi fi
else else
echo "nothing todo" echo "nothing todo"
@ -49,6 +50,7 @@ for p in * ; do
fi fi
fi fi
set -e
echo "update docs" echo "update docs"
helm-docs -t ./README.md.gotmpl -t _docs.gotmpl -o README.md -g "${p}" helm-docs -t ./README.md.gotmpl -t _docs.gotmpl -o README.md -g "${p}"
helm-docs -t ./README.adoc.gotmpl -t _docs.gotmpl -o README.adoc -g "${p}" helm-docs -t ./README.adoc.gotmpl -t _docs.gotmpl -o README.adoc -g "${p}"
@ -58,15 +60,18 @@ for p in * ; do
helm push "${p}-${v}.tgz" "${HELM_REPO_URL}"; helm push "${p}-${v}.tgz" "${HELM_REPO_URL}";
echo "update artifacthub.io" echo "update artifacthub.io"
set +e
oras push "${HELM_REPO}/${p}:artifacthub.io" \ oras push "${HELM_REPO}/${p}:artifacthub.io" \
--config /dev/null:application/vnd.cncf.artifacthub.config.v1+yaml \ --config /dev/null:application/vnd.cncf.artifacthub.config.v1+yaml \
"${p}/artifacthub-repo.yml":application/vnd.cncf.artifacthub.repository-metadata.layer.v1.yaml "${p}/artifacthub-repo.yml":application/vnd.cncf.artifacthub.repository-metadata.layer.v1.yaml
echo "push to git" echo "push to git"
set -e
git add "${p}/" "docs/modules/charts/nav.adoc" "docs/modules/charts/pages/${p}.adoc" git add "${p}/" "docs/modules/charts/nav.adoc" "docs/modules/charts/pages/${p}.adoc"
git commit -m "${COMMIT_SCOPE}(${p}): ${COMMIT_MESSAGE}" git commit -m "${COMMIT_SCOPE}(${p}): ${COMMIT_MESSAGE}"
git tag "${tag}" --no-sign; git tag "${tag}" --no-sign;
git push --tags origin main; git push --tags origin main;
set +e
echo echo
done done