-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
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
CI: check yard & mdl output #14156
CI: check yard & mdl output #14156
Conversation
Review period will end on 2022-11-18 at 19:55:46 UTC. |
We no longer expose our install of Bundler at all and there's no dev-cmd entry point beyond what Though a Bundler installation from an external Ruby via If any Bundler 2.3 is available (which I think |
15ab058
to
e4a013b
Compare
e4a013b
to
a7951db
Compare
Review period ended. |
8522085
to
479000f
Compare
479000f
to
8cbb32f
Compare
Seems to be working now. For now it won't hold up any future PRs until these steps are enabled:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work here! If/when you merge this: please open another draft PR with the broken YARD stuff and I'll attempt to figure it out and push to it.
.github/workflows/docs.yml
Outdated
BUNDLE_GEMFILE: ../../rubydoc/Gemfile | ||
run: | | ||
bundle install --jobs 4 --retry 3 | ||
bundle exec yard doc --plugin sorbet --no-output #--fail-on-warning |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I reckon it's maybe work splitting this into a separate job given it's working on a different Bundler? Thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you may be overestimating my knowledge of bundler, gems, and Ruby in general… 🙃
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@EricFromCanada Sorry, I mean the two differing Gemfile
/BUNDLE_GEMFILE
bits here may make sense to be in different GitHub Actions jobs in the same file. Thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They're now in separate jobs. Only outstanding item is the Test Everything check which seems to be unrelated.
e548999
to
fb12079
Compare
With fixes for Markdown syntax to allow tests to pass.
fb12079
to
d9ef454
Compare
Thanks again @EricFromCanada! |
brew style
with your changes locally?brew typecheck
with your changes locally?brew tests
with your changes locally?An attempt at having CI test for issues with YARD's rubydoc generation. Doesn't currently work because I'm unsure of how to get bundler working. (Next step after that would be to add Markdown formatting checks using
mdl
now that it's shipped a release with this fix, although it now requires Ruby 2.7.)