Skip to content

Update README.md #2934

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 2 commits into from
Jun 16, 2025
Merged

Update README.md #2934

merged 2 commits into from
Jun 16, 2025

Conversation

kgangulyvibe
Copy link
Contributor

Build mode none is in public preview for C/C++. Readme updated.

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Confirm the readme has been updated if necessary.
  • Confirm the changelog has been updated if necessary.

Build mode `none` is in public preview for C/C++. Readme updated.
@Copilot Copilot AI review requested due to automatic review settings June 16, 2025 04:43
@kgangulyvibe kgangulyvibe requested a review from a team as a code owner June 16, 2025 04:43
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the documentation for the none build mode to reflect that it is now in public preview for C/C++.

  • Clarifies that C/C++ support is in public preview rather than unsupported.
  • Adjusts the list of languages for which none is not yet supported.
Comments suppressed due to low confidence (1)

README.md:58

  • [nitpick] Consider adding a comma before "and" for clearer separation (e.g., ... Kotlin, and it is in public preview for C/C++.) and removing the backticks around "public preview" since it's not a build-mode flag.
+ `none` build mode is also simpler to set up and is slightly faster to run, but there is a possibility that some alerts will be missed. This may happen if your repository does any code generation during compilation or if there are any dependencies downloaded from registries that the workflow does not have access to. `none` is not yet supported by Swift, Go, or Kotlin and it is in `public preview` for C/C++.

Copy link
Member

@mbg mbg left a comment

Choose a reason for hiding this comment

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

Hi @kgangulyvibe 👋🏻

Thanks for noticing this and preparing a PR to improve it! I'd be happy to merge this with the two minor changes I proposed.

Co-authored-by: Michael B. Gale <mbg@github.com>
Copy link
Contributor Author

@kgangulyvibe kgangulyvibe left a comment

Choose a reason for hiding this comment

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

Updated!

Copy link
Member

@mbg mbg left a comment

Choose a reason for hiding this comment

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

Thank you very much!

@mbg mbg enabled auto-merge June 16, 2025 11:00
@mbg mbg merged commit ece6bb6 into github:main Jun 16, 2025
268 checks passed
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