Skip to content

Add build script - #177

Merged
robobario merged 1 commit into
kroxylicious:mainfrom
robobario:add-build-script
Jul 30, 2025
Merged

Add build script#177
robobario merged 1 commit into
kroxylicious:mainfrom
robobario:add-build-script

Conversation

@robobario

Copy link
Copy Markdown
Member

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.

@robobario
robobario requested a review from a team as a code owner July 30, 2025 01:59
@tombentley

Copy link
Copy Markdown
Member

Add a build script so that we can build the same way locally and in CI

I think you should explain in the README how and why people would run this locally

@robobario

Copy link
Copy Markdown
Member Author

done

@robobario

Copy link
Copy Markdown
Member Author

Comment thread README.md Outdated
Comment on lines +52 to +53
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.

Copy link
Copy Markdown
Member

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)

Copy link
Copy Markdown
Member Author

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 <robertyoungnz@gmail.com>

@tombentley tombentley left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Perfect, thanks!

@robobario
robobario merged commit 52e8dcb into kroxylicious:main Jul 30, 2025
2 checks passed
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