Skip to content

ci: multiple ruby configuration fixes#115

Open
baywet wants to merge 6 commits into
OAI:mainfrom
baywet:ci/ruby-setup
Open

ci: multiple ruby configuration fixes#115
baywet wants to merge 6 commits into
OAI:mainfrom
baywet:ci/ruby-setup

Conversation

@baywet

@baywet baywet commented Jul 9, 2026

Copy link
Copy Markdown
Member

this PR drops a bunch of outdated gems that made it difficult / impossible to run the site locally. It also switches from automatic publishing to workflow based (we'll need to flip the switch in the settings) and adds a vscode task to run the container

baywet added 3 commits July 9, 2026 14:09
Signed-off-by: Vincent Biret <vincentbiret@hotmail.com>
Signed-off-by: Vincent Biret <vincentbiret@hotmail.com>
Signed-off-by: Vincent Biret <vincentbiret@hotmail.com>
@baywet baywet requested review from a team as code owners July 9, 2026 18:38
baywet added 2 commits July 9, 2026 14:39
Signed-off-by: Vincent Biret <vincentbiret@hotmail.com>
Signed-off-by: Vincent Biret <vincentbiret@hotmail.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR modernizes the Ruby/Jekyll toolchain for the site to improve local development and updates CI/CD to deploy the site via a dedicated GitHub Actions Pages workflow.

Changes:

  • Replace the github-pages gem stack with direct jekyll ~> 4.4 dependencies and refresh the lockfile (Bundler 2.6.x).
  • Add a GitHub Actions workflow to build and deploy the Jekyll site to GitHub Pages.
  • Improve local dev ergonomics via updated Docker instructions, a VS Code task, and ignoring the local Bundler cache (.bundle/).

Reviewed changes

Copilot reviewed 4 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
Gemfile.lock Updates dependency resolution to Jekyll 4.4.x and newer supporting gems; updates Bundler version.
Gemfile Switches from github-pages to direct jekyll + plugin/theme gems for local dev compatibility.
CONTRIBUTING.md Updates Docker-based dev instructions and documents the new VS Code task.
.vscode/tasks.json Adds a VS Code task to run Jekyll via Docker with a local gem cache path.
.gitignore Ignores .bundle/ created by the Docker/local bundler cache path.
.github/workflows/deploy-pages.yml Adds a Pages build+deploy workflow using Ruby setup, Jekyll build, and Pages artifact/deploy actions.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .vscode/tasks.json
Comment on lines +29 to +34
"pattern": {
"regexp": "^.*$",
"file": 1,
"line": 2,
"message": 3
},
Comment thread .vscode/tasks.json
Comment on lines +9 to +16
"run", "--rm",
"--volume=${workspaceFolder}:/srv/jekyll:Z",
"-p", "4000:4000",
"-e", "BUNDLE_PATH=/srv/jekyll/.bundle",
"-w", "/srv/jekyll",
"jekyll/jekyll",
"sh", "-c",
"bundle install && bundle exec jekyll serve -H 0.0.0.0 --force_polling"
Comment thread CONTRIBUTING.md
Comment on lines 13 to +19
docker run --rm \
--volume="$PWD:/srv/jekyll:Z" \
-p '4000:4000' \
-p 4000:4000 \
-e BUNDLE_PATH=/srv/jekyll/.bundle \
-w /srv/jekyll \
jekyll/jekyll \
jekyll serve
sh -c "bundle install && bundle exec jekyll serve -H 0.0.0.0 --force_polling"
@ralfhandl

Copy link
Copy Markdown
Contributor

Running locally works on macOS
Running via Docker works
VS Code task works

Haven't checked the new publishing workflow, not my area of expertise.

@baywet

baywet commented Jul 10, 2026

Copy link
Copy Markdown
Member Author

Thanks for confirming all those platforms @ralfhandl
I've on my side tested windows, and vscode in windows.

@ralfhandl

Copy link
Copy Markdown
Contributor

Did you test the new publishing workflow in a fork of this repo?

@baywet

baywet commented Jul 10, 2026

Copy link
Copy Markdown
Member Author

@ralfhandl I can't, we need to change a setting on the repo as far as I understand, and I don't have those permissions

@ralfhandl

ralfhandl commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

If you fork the repo, you have the permissions in your fork to deploy to the default GH-pages site. And this is a good test of what you have to change in the GH-pages settings.

@ralfhandl

Copy link
Copy Markdown
Contributor

I've created a fork that uses deploy-pages.yml to publish the website, the result is unsatisfactory: https://ralfhandl.github.io/spec.openapis.org/.

Not my area of expertise, so I won't dig into why it looks so weird.

@baywet

baywet commented Jul 10, 2026

Copy link
Copy Markdown
Member Author

@ralfhandl this is cause by the combination of the facts:

  • we had absolute urls for the assets
  • your fork test is serving under a sub-path

I've pushed a fix, could you merge that into your fork please?

(not setting up my own fork because I have a blog at https://baywet.github.io and I'm afraid it'll mess it up)

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.

3 participants