Docs: Updates for Ruby support #6887
Conversation
shati-patel
left a comment
There was a problem hiding this comment.
(wrong "@Shati" pinged in the OP 😉 )
- I haven't added a link to Ruby query help on this page https://codeql.github.com/codeql-query-help/, or the https://codeql.github.com/codeql-query-help/ruby/ page that contains the link to the individual query help pages, as I'm not sure how much of this is added/updated automatically.
- As above, I also haven't added a Ruby link to the "CodeQL CWE coverage" page https://codeql.github.com/codeql-query-help/codeql-cwe-coverage/. Does the CWE page for Ruby get automatically generated.
I'll take a look along with my changes to the automation - if anything needs to be added manually, I'll make sure to do that!
6f34735
|
@calumgrant What's the minimum Ruby version we support? What are the glibc requirements? |
|
In terms of Ruby version, there is no minimum version. For the public beta, there will be a minimum supported version of glibc - TBD. (I'm still investigating this). The the GA, we hope to make this more robust by linking glibc statically. Tracked in https://github.com/github/codeql-team/issues/550 |
|
We require glibc 2.17 |
I'm not sure where this should be documented for Ruby. I can't find a similar requirement for other languages in the docs on https://codeql.github.com/docs/ @jf205 / @shati-patel - do you have a view on where to document this 👆? |
We have a table of supported languages and compilers. Maybe there should be an entry for Ruby and glibc 2.17 there? (The source file is https://github.com/github/codeql/blob/main/docs/codeql/support/reusables/versions-compilers.rst) |
|
We should def add it, as it has been causing issues for customers in the private beta. We can flesh this out for other languages over time. |
|
@shati-patel / @turbo - Thanks I think I'll add a footnote for Ruby. |
This is a sister PR to Calum's PR #6860 which adds new articles for Ruby,
and a companion to this PR for the changes to the articles on docs.github.com.
This PR mentions Ruby in various existing articles.
See the 2nd half of the documentation plan (https://github.com/github/docs-content-strategy/blob/main/content-design-plans/docs-content/5017/plan.md#on-codeqlgithubcomdocs) for details of the changes.
NOTES
@shati-patel:
TODO: Once Calum's PR is mergedEDIT: now done ✅update
docs/codeql/codeql-language-guides/codeql-for-ruby.rstadding this line:.. include:: ../reusables/ruby-beta-note.rstAdding it to Calum's PR now won't work as the reusable is in my PR.