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

Update dynamic README workflow to open a Pull Request #31

Merged
merged 4 commits into from
Apr 10, 2024

Conversation

stefannibrasil
Copy link
Contributor

Some repositories have a protected branch rule. That means our workflow won't work because commiting directly to main
is not allowed. To prevent that, the workflow will now open a PR for the changes. Rather than chancing the repo rules, updating the workflow is easier. Probably safer, too.

Other updates include only running the workflow when the README is updated. And removing the leading / that indicates it's a file (but it isn't). @nickcharlton pointed it out here. It must have been needed when I was testing things but it works fine without it on this test repo.

Some repositories have a protected branch rule. That means
our workflow won't work because commiting directly to main
is not allowed. To prevent that, the workflow will now
open a PR for the changes.
We only want to run this workflow if the README has changed, not
on every change.
As @nickcharlton pointed out,

> the leading / implies to me the start of a filesystem,
which it presumably isn't.

I tested removing it and it worked, so it was probably
needed when I was testing things but it's not needed anymore.
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.

None yet

1 participant