Skip to content

Add a build:local_ruby task to simplify local testing flow #1281

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

Merged
merged 3 commits into from
Jan 24, 2025

Conversation

st0012
Copy link
Member

@st0012 st0012 commented Jan 23, 2025

A common way to test RDoc changes is to build ruby/ruby's documentation with the latest RDoc changes. When RDoc was a default gem, we can sync it to ruby/ruby with its tool/sync_default_gems.rb script.

Now that RDoc is a bundled gem, we need to use a different method to sync it to ruby/ruby. And so far building it and moving it to ruby/ruby's bundled gems folder is the easiest way to do it.

Copy link
Member

@kou kou left a comment

Choose a reason for hiding this comment

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

Can we use this in .github/workflows/ruby-core.yml?

Rakefile Outdated
@@ -99,6 +99,11 @@ task :clean do
end
end

desc "Build #{Bundler::GemHelper.gemspec.full_name} and move it to local ruby/ruby project's bundled gems folder"
task build_for_local_ruby: :build do
Copy link
Member

Choose a reason for hiding this comment

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

Can we use better task name something like local_ruby:build?

Copy link
Member Author

Choose a reason for hiding this comment

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

Renamed it to build:local_ruby

A common way to test RDoc changes is to build `ruby/ruby`'s documentation
with the latest RDoc changes. When RDoc was a default gem, we can
sync it to `ruby/ruby` with its `tool/sync_default_gems.rb` script.

Now that RDoc is a bundled gem, we need to use a different method to
sync it to `ruby/ruby`. And so far building it and moving it to
`ruby/ruby`'s bundled gems folder is the easiest way to do it.
@st0012 st0012 force-pushed the add-build-for-local-ruby-task branch from be43c22 to c9c47e3 Compare January 24, 2025 10:48
@st0012 st0012 requested review from kou and vinistock January 24, 2025 15:23
@st0012 st0012 changed the title Add a build_for_local_ruby task to simplify local testing flow Add a build:local_ruby task to simplify local testing flow Jan 24, 2025
@st0012 st0012 merged commit c2eef4b into master Jan 24, 2025
51 checks passed
@st0012 st0012 deleted the add-build-for-local-ruby-task branch January 24, 2025 15:54
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