Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix release of helm docs #2

Merged
merged 3 commits into from
Oct 17, 2024
+41 −2
Merged

fix release of helm docs #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4d21199
fix release of helm docs
matilote Oct 17, 2024
d7a88ff
Merge 4d21199960db111031fe0b0185782ab9b753d47b into 97ef6a1dec70c69c9…
matilote Oct 17, 2024
a104451
docs: auto-generate chart docs
github-actions[bot] Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/helm-docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,13 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v4
with:
persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token
fetch-depth: 0

- name: Set up Docker
uses: docker/setup-buildx-action@v2

- name: Run helm-docs
run: docker run --rm -v $(pwd):/helm-docs jnorwood/helm-docs:v1.14.2 --chart-search-root=. --template-files=./.github/helm-docs/_templates.gotmpl --template-files=README.md.gotmpl
run: docker run --rm -v $(pwd):/helm-docs jnorwood/helm-docs:v1.14.2 --chart-search-root=charts --template-files=./.github/helm-docs/_templates.gotmpl --template-files=README.md.gotmpl

- name: Commit & Push changes
uses: actions-js/push@master
Expand Down
40 changes: 40 additions & 0 deletions charts/jrpc-interceptor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# jrpc-interceptor

![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: main](https://img.shields.io/badge/AppVersion-main-informational?style=flat-square)

A Helm chart for the JRPC Interceptor application

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| Nethermind | | <https://nethermind.io> |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| env.LOG_SERVER_DEBUG | string | `"true"` | |
| env.SERVICE_TO_PROXY | string | `"op-fullnode-op-execution:8545"` | |
| env.USE_PROMETHEUS | string | `"true"` | |
| host | string | `"0.0.0.0"` | |
| image.pullPolicy | string | `"Always"` | |
| image.repository | string | `"ghcr.io/nethermindeth/jrpc-interceptor"` | |
| image.tag | string | `"main"` | |
| ports.http | int | `8081` | |
| ports.logServer | int | `514` | |
| ports.metrics | int | `9120` | |
| replicaCount | int | `1` | |
| resources.limits.cpu | string | `"100m"` | |
| resources.limits.memory | string | `"128Mi"` | |
| resources.requests.cpu | string | `"100m"` | |
| resources.requests.memory | string | `"128Mi"` | |
| service.type | string | `"ClusterIP"` | |
| serviceMonitor.additionalLabels | object | `{}` | |
| serviceMonitor.enabled | bool | `true` | |
| serviceMonitor.interval | string | `"15s"` | |
| serviceMonitor.namespace | string | `""` | |
| serviceMonitor.scrapeTimeout | string | `"10s"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)