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: add workflow to check for generating website files #2006

Closed
wants to merge 7 commits into from

Conversation

fry69
Copy link
Contributor

@fry69 fry69 commented Oct 10, 2024

This workflow checks if website files should have been generated.

Problems I noticed while building this:

These two problematic files get excluded via a fresh script for this workflow (should get removed if those two problems above get addressed).

Update: Improved wording a bit.

@fry69 fry69 force-pushed the docs-workflow-fix branch from 33fe0e6 to 9f1b915 Compare October 10, 2024 11:10
@paul-gauthier
Copy link
Collaborator

Currently I use a pre push hook for updating the docs.

@fry69
Copy link
Contributor Author

fry69 commented Oct 10, 2024

Currently I use a pre push hook for updating the docs.

Unfortunately not everybody who proposes a PR is using these hooks.

This workflow gives instant feedback if a PR includes content that gets overwritten or hints that the update-docs.sh script should get run to complete the PR.

@paul-gauthier
Copy link
Collaborator

Yes, I understand. But I think it's wise for a human to review the automatic doc updates before committing and publishing them to the web site. The doc updates occasionally reveal a bug or systemic problem with the recent code changes, sometimes resulting in a large swath of broken docs.

@fry69
Copy link
Contributor Author

fry69 commented Oct 10, 2024

This workflow provides exactly this feedback. It does not change or update anything.

@paul-gauthier
Copy link
Collaborator

Why have you duplicated the update-docs.sh script? Seems like a maintenance burden.

Also, it will give you an exit code. No need to diff.

./scripts/update-docs.sh --check

if [ $? -ne 0 ]; then
    echo "Docs needed to be updated, aborting."

@fry69
Copy link
Contributor Author

fry69 commented Oct 10, 2024

Why have you duplicated the update-docs.sh script? Seems like a maintenance burden.

I sincerely hope this is a maintenance burden since the reason for this are the two points I mentioned in the initial proposal. They need to be fixed. Then this additional script can get deleted.

Also, it will give you an exit code. No need to diff.

Diffing has the nice side effect that may be already obvious from the error log what went wrong.

@fry69 fry69 closed this Oct 10, 2024
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.

2 participants