feat(release): add --docs-only flag to perform tool - #445
Merged
Conversation
codyoss
force-pushed
the
docs-only
branch
8 times, most recently
from
August 10, 2026 16:28
41696ea to
54290d1
Compare
Add the `--docs-only` flag to `toys release perform` to support the Exit Gate two-stage release workflow, allowing documentation (YARD and Cloud RAD) to be built and published independently of releasing the gem. Key changes: - Add `--docs-only` flag to `toys/release/perform.rb`. - Bypass version checking, skip gem publishing, and force doc publishing when `--docs-only` is set. - Remove `include :gems` from `toys/release/perform.rb` to resolve method name collision with the `:gems` CLI flag. - Improve `transform_links` exception safety to ensure markdown link transformations are reverted even if an error occurs midway. - Add integration tests in `test/release_perform_test.rb`. - Add test dependencies (`toys`, `gems`, `jwt`) to `Gemfile`. - Add `/vendor/` to `.gitignore`.
torreypayne
requested changes
Aug 19, 2026
torreypayne
left a comment
torreypayne
left a comment
Member
There was a problem hiding this comment.
Thanks for adding the new flag!
I'm wondering if we could trim this PR down to just the minimal logic required for the --docs-only flag in toys/release/perform.rb? There are a lot of modifications to the API surface to accommodate the new test pattern for Toys that you've added, and I'm thinking we might want to align on that as a group independently of the flag addition.
Member
Author
|
You are right that removing the tests does simplify things quite a bit here, but it feels bad the code is untested now. I don't maintain this code nor do I profess to have any Ruby expertise so I will trust your judgement here but I would recommend with coming up with a testing strategy of some-sort for the tooling here. |
torreypayne
approved these changes
Aug 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add the
--docs-onlyflag totoys release performto support theExit Gate two-stage release workflow, allowing documentation (YARD and
Cloud RAD) to be built and published independently of releasing the gem.
Key changes:
--docs-onlyflag totoys/release/perform.rb.when
--docs-onlyis set.enable_docstoreleaser.runinperform_release_gem.include :gemsfromtoys/release/perform.rbto resolvemethod name collision with the
:gemsCLI flag.