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

add workflow to generate README.md #188

Merged
merged 1 commit into from Sep 4, 2021

Conversation

kd7lxl
Copy link
Collaborator

@kd7lxl kd7lxl commented Jul 30, 2021

What this PR does:
This adds a Github Action workflow to automate running make (helm-docs) on each PR and committing any changes.

This is a continuation of the work in #183.

Github Actions workflows will not trigger on commits pushed by Github Actions (differentiated by the auto auth token), so this workflow will cause the Lint and Test workflow to not run. Since that is a required workflow, the PR cannot be merged until Lint and Test is triggered some other way, like closing and reopening the PR. I've left this PR in draft mode while we try to find the best solution to automate running make without defeating the required PR status checks.

Which issue(s) this PR fixes:
Fixes #187

@kd7lxl kd7lxl mentioned this pull request Jul 30, 2021
1 task
@nschad nschad added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Jul 30, 2021
@nschad
Copy link
Collaborator

nschad commented Jul 30, 2021

We will have to test it here but maybe this will do the trick

on:
  push:
    paths-ignore:
      - 'README.md*'
      - 'docs/**'
      - 'tools/**'
    branches:
      // kinda pointless, nobody should ever push to main/master
      - main
      - master
  pull_request:

and readme.yml workflow

on:
push:
  paths:
    - 'README.md*'
    - values.yaml
pull_request:

Also I am not completely sure what happens when the ci test workflow is not run the 2nd time. Is the check just skipped? Is it marked as failed? Does the infinite-loop protection not even bother to check if it has to run the workflow (then it wouldn't work anyway)?

@kd7lxl
Copy link
Collaborator Author

kd7lxl commented Jul 30, 2021

Also I am not completely sure what happens when the ci test workflow is not run the 2nd time. Is the check just skipped?

Yes, it is just skipped, so it stays 🟠 indefinitely.

@kd7lxl
Copy link
Collaborator Author

kd7lxl commented Jul 30, 2021

on:
  push:
    branches:
      // kinda pointless, nobody should ever push to main/master
      - main
      - master

BTW, this would run any time a PR was merged to main/master. If it tries to commit, it will fail since branch protection is enabled.

@nschad
Copy link
Collaborator

nschad commented Jul 30, 2021

on:
  push:
    branches:
      // kinda pointless, nobody should ever push to main/master
      - main
      - master

BTW, this would run any time a PR was merged to main/master. If it tries to commit, it will fail since branch protection is enabled.

yep thats why I added the comment. I am gonna ask some people, maybe somebody has a bright idea

with:
add: README.md
default_author: github_actions
message: "[skip ci] generate README.md"
Copy link
Collaborator

Choose a reason for hiding this comment

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

this should fix our infinite-loop problem @kd7lxl

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

lgtm!

Signed-off-by: Tom Hayward <thayward@infoblox.com>

improve CI rules

Signed-off-by: ShuzZzle <niclas.schad@gmail.com>
@nschad nschad marked this pull request as ready for review September 3, 2021 18:49
@nschad
Copy link
Collaborator

nschad commented Sep 4, 2021

Alright I think its fine currently how it is @kd7lxl
Do you wanna give your final Approval or do you have any objections?

@kd7lxl
Copy link
Collaborator Author

kd7lxl commented Sep 4, 2021

lgtm

@kd7lxl kd7lxl merged commit 6620fde into cortexproject:master Sep 4, 2021
@kd7lxl kd7lxl deleted the generate-readme branch September 4, 2021 14:30
kd7lxl added a commit that referenced this pull request Sep 10, 2021
kd7lxl added a commit that referenced this pull request Sep 10, 2021
This reverts commit 6620fde.

Signed-off-by: Tom Hayward <thayward@infoblox.com>
kd7lxl added a commit to kd7lxl/cortex-helm-chart that referenced this pull request Sep 10, 2021
This reverts commit 6620fde.

Signed-off-by: Tom Hayward <thayward@infoblox.com>
nschad pushed a commit that referenced this pull request Sep 10, 2021
This reverts commit 6620fde.

Signed-off-by: Tom Hayward <thayward@infoblox.com>
danfromtitan pushed a commit to danfromtitan/cortex-helm-chart that referenced this pull request Sep 27, 2021
…exproject#217)

This reverts commit 6620fde.

Signed-off-by: Tom Hayward <thayward@infoblox.com>
Signed-off-by: Dan Constantinescu <dconstantinescu@blackberry.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

automate generation of readme.md
2 participants