Skip to content

Commit

Permalink
feat(helm-docs): Run helm-docs as part of the release automation (#147)
Browse files Browse the repository at this point in the history
* Run helm-docs as part of the release automation

Fixes e.g. #146

* Simplify go run

* feat(github): Add helm-docs atucommit code

---------

Co-authored-by: Marcin Jasion <[email protected]>
  • Loading branch information
0x2b3bfa0 and mjasion authored Aug 2, 2023
1 parent 60034e9 commit b5d0739
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 2 deletions.
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 }}

- 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
- uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: Helm-Docs update
file_pattern: charts/studio/README.md

3 changes: 1 addition & 2 deletions .github/workflows/studio_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,10 @@ jobs:
done
- uses: iterative/setup-cml@v1
- run: >
cml pr create
cml pr create .
--{title,body,message}="Studio: bump to $STUDIO_VERSION"
--branch="bump-studio-$STUDIO_VERSION"
--squash
.
env:
GITHUB_TOKEN: ${{ secrets.OLIVAW_GITHUB_PERSONAL_ACCESS_TOKEN }}
- run: >
Expand Down

0 comments on commit b5d0739

Please sign in to comment.