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.

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

feat(helm-docs): Run helm-docs as part of the release automation #147

Merged
merged 3 commits into from
Aug 2, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
45 changes: 45 additions & 0 deletions .github/workflows/helm-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Create helm-docs

on:
pull_request:
merge_group:
push:
branches:
- main
workflow_dispatch:

concurrency:
group: '${{ github.workflow }} @ ${{ github.ref }}'
cancel-in-progress: true

jobs:
helm-docs:
runs-on: ubuntu-latest
steps:
- name: Generate token
id: generate_token
uses: tibdex/github-app-token@b62528385c34dbc9f38e5f4225ac829252d1ea92
with:
app_id: ${{ secrets.PROJECT_ACTIONS_MANAGEMENT_APP_ID }}
private_key: ${{ secrets.PROJECT_ACTIONS_MANAGEMENT_APP_PEM }}
Comment on lines +19 to +24
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I right now used the GitHub App, but will propose some naming conventions for apps per repo or role 🤔


- name: Checkout
uses: actions/checkout@v3
with:
token: ${{ steps.generate_token.outputs.token }}

- name: Run helm-docs from go
working-directory: charts/studio/
run: |
go run github.com/norwoodj/helm-docs/[email protected]

- name: Run helm-docs
working-directory: charts/studio/
run: |
docker run --pull always --rm --volume "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:latest
0x2b3bfa0 marked this conversation as resolved.
Show resolved Hide resolved
0x2b3bfa0 marked this conversation as resolved.
Show resolved Hide resolved

- uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: Helm-Docs update
file_pattern: charts/studio/README.md
0x2b3bfa0 marked this conversation as resolved.
Show resolved Hide resolved

3 changes: 0 additions & 3 deletions .github/workflows/studio_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@ jobs:
do
go run github.com/mikefarah/yq/[email protected] eval --inplace "$expression" charts/studio/Chart.yaml
done
- run: |
go run github.com/norwoodj/helm-docs/[email protected]
working-directory: charts/studio
- uses: iterative/setup-cml@v1
- run: >
cml pr create .
Expand Down