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

Unify local and GitHub Actions website generation flow #274

Merged
merged 6 commits into from
Oct 9, 2022

Conversation

japborst
Copy link
Member

@japborst japborst commented Oct 3, 2022

A follow-up from #253 (comment):

A big downside of the standard GitHub actions set up, is that one can not locally run this. Additionally, setting versions in the gemfile can quickly go out of date or misaligned compared to the GHA configuration.

Here, we're moving away from the default GH pages configuration and run the jekyll commands ourselves s.t. we can specify all versions in our own gemfile.

@japborst japborst added the chore A task not related to code (build, formatting, process, ...) label Oct 3, 2022
@japborst japborst force-pushed the japborst/local-builds branch from 44acf55 to 16481cb Compare October 3, 2022 18:24
Base automatically changed from sschroevers/deploy-to-github-pages to master October 4, 2022 07:08
@Stephan202 Stephan202 force-pushed the japborst/local-builds branch from 16481cb to ba9d437 Compare October 4, 2022 07:15
@Stephan202
Copy link
Member

Rebased; PR now targets master.

@Stephan202 Stephan202 added this to the 0.4.0 milestone Oct 7, 2022
@Stephan202 Stephan202 force-pushed the japborst/local-builds branch from e3fbaa3 to 8c1bdd8 Compare October 7, 2022 11:02
Copy link
Member

@Stephan202 Stephan202 left a comment

Choose a reason for hiding this comment

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

Rebased and added a commit. Very nice quality improvement!

Suggested commit message:

Unify local and GitHub Actions website generation flow (#274)

.github/workflows/deploy-website.yaml Outdated Show resolved Hide resolved
generate-docs.sh Show resolved Hide resolved
gem "jekyll", "4.2.2"
gem "jekyll-sitemap", "1.4"
gem "just-the-docs", "0.4.0.rc2"
gem "webrick", "1.7"
Copy link
Member

Choose a reason for hiding this comment

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

For other reviewers: webrick is used by jekyll serve.

website/README.md Outdated Show resolved Hide resolved
Copy link
Member

@rickie rickie left a comment

Choose a reason for hiding this comment

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

Added a commit.

Nice improvements 🎉.

website/README.md Show resolved Hide resolved
website/README.md Outdated Show resolved Hide resolved
website/README.md Outdated Show resolved Hide resolved
@japborst japborst changed the title Streamline local development set-up with GitHub actions to build the documentation website Unify local and GitHub Actions website generation flow Oct 9, 2022
@japborst japborst merged commit 757d5b1 into master Oct 9, 2022
@japborst japborst deleted the japborst/local-builds branch October 9, 2022 17:43
Comment on lines +27 to +32
###### Switch Ruby versions

The required Ruby version is set in `.ruby-version`. To switch, you can use
[rvm][rvm] to manage your Ruby version.

###### Resolve Bundler issues
Copy link
Member

Choose a reason for hiding this comment

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

@japborst I changed the grammar of these headers on purpose: the topic is "switch​ing Ruby versions" and "resolve​ing Bundler issues". This also matches the format used for the top-level README. Any particular reason this was reverted?

Copy link
Member Author

Choose a reason for hiding this comment

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

Reverted to be in line with the rest.

Copy link
Member

@Stephan202 Stephan202 Oct 9, 2022

Choose a reason for hiding this comment

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

The other headers do not use the imperative mood either?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore A task not related to code (build, formatting, process, ...)
Development

Successfully merging this pull request may close these issues.

3 participants