-
Notifications
You must be signed in to change notification settings - Fork 11
Add build script #177
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 build script #177
Conversation
I think you should explain in the README how and why people would run this locally |
8112794 to
ca15298
Compare
|
done |
|
I've tested the github automation on my fork main run: https://github.com/robobario/kroxylicious.github.io/actions/runs/16611488912 |
README.md
Outdated
| Sometimes it can be useful to build the same static output that is deployed to GitHub Pages. For example, you may need to test some Jekyll | ||
| changes produce the URLs you expect in production. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you should spell out a little more clearly what the difference between build.sh and run.sh is, in use case terms. And probably move this section before the section about running on a fork (which seems to me like a more advanced thing to want to do)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
have re-ordered them and started off each section with a usecase type statement.
run.sh is for contributors developing the content. build.sh and the deploy-to-fork sections are more useful for contributors developing the build automation.
So that we can execute a local production build the same way we do in CI Signed-off-by: Robert Young <[email protected]>
ca15298 to
47c3ac5
Compare
tombentley
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perfect, thanks!
Add a build script so that we can build the same way locally and in CI
I'm experimenting with some automation for checking that all the links within the generated HTML are valid, having a way to produce the production build output locally is helpful.