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

Conversation

0x2b3bfa0
Copy link
Member

Fixes e.g. #146

@0x2b3bfa0 0x2b3bfa0 requested a review from a team August 1, 2023 14:49
@0x2b3bfa0 0x2b3bfa0 self-assigned this Aug 1, 2023
@mjasion
Copy link
Contributor

mjasion commented Aug 2, 2023

@0x2b3bfa0 maybe we could commit this to the PR 🤔
https://github.com/iterative/helm-charts/blob/main/.github/workflows/test.yaml#L76-L80

- 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
git diff --exit-code

@mjasion
Copy link
Contributor

mjasion commented Aug 2, 2023

Comment on lines +19 to +24
- 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 }}
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 🤔

.github/workflows/helm-docs.yaml Show resolved Hide resolved
@mjasion mjasion changed the title Run helm-docs as part of the release automation feat(helm-docs): Run helm-docs as part of the release automation Aug 2, 2023
@0x2b3bfa0 0x2b3bfa0 added this pull request to the merge queue Aug 2, 2023
Merged via the queue into main with commit b5d0739 Aug 2, 2023
@0x2b3bfa0 0x2b3bfa0 deleted the 0x2b3bfa0-patch-1 branch August 2, 2023 14:47
Copy link
Contributor

@jesper7 jesper7 left a comment

Choose a reason for hiding this comment

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

Looks great! Just a minor comment

.github/workflows/helm-docs.yaml Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants