Skip to content

test: add docSupport test and add docSupport version check#212

Closed
hukaidong wants to merge 2 commits into
bobvanderlinden:masterfrom
hukaidong:docSupportChecks
Closed

test: add docSupport test and add docSupport version check#212
hukaidong wants to merge 2 commits into
bobvanderlinden:masterfrom
hukaidong:docSupportChecks

Conversation

@hukaidong
Copy link
Copy Markdown
Contributor

There is a do-install-doc issue related to ruby version < 3.4.
This commit checks doc support for ruby version >= 3.4 and add guard
perventing docSupport be used in parallel build with early versions.

See: ruby/rubygems#7580

@hukaidong
Copy link
Copy Markdown
Contributor Author

there are quite a lot of feedback on nix and(with) ruby communities about documentation failures. Here I'm trying to make this guardian as the first step. It make sure ri is working on compile-time ruby core documentations. Once this is merged, I gonna push an other pr work for gem documents. There's still some other built-in documentations like Rake, CSV not accessible through derivation. They are out of current scope and plan to fix in next one

Copy link
Copy Markdown
Owner

@bobvanderlinden bobvanderlinden left a comment

Choose a reason for hiding this comment

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

Ah ok, so running the docSupport part of the build in parallel results in problems in <3.4. These tests make sense 👍

There is a do-install-doc issue related to ruby version < 3.4.
This commit checks doc support for ruby version >= 3.4 and add guard
perventing docSupport be used in parallel build with early versions.

See: ruby/rubygems#7580
auto-merge was automatically disabled April 11, 2026 18:41

Head branch was pushed to by a user without write access

rdoc tries to create XDG_DATA_DIR (defaulting to $HOME/.local/share) during the build, but $HOME is read-only in the Nix sandbox.

This adds a writable $HOME during the preConfigure phase, and applies the
same fix to the docSupport tests in flake.nix.

See: #221

Co-Authored-By: Sander <hey@sandydoo.me>
@hukaidong
Copy link
Copy Markdown
Contributor Author

I borrowed #221 change here so macOS check could be passed.

bobvanderlinden added a commit that referenced this pull request Apr 15, 2026
Duplicate of #212 but updated to use parallel CI from #225, so that
builds won't timeout on GHA.

Closes #212 
Closes #221
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