Skip to content
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

Change "recommended" to "minimum" #2451

Merged
merged 2 commits into from
Sep 4, 2024
Merged

Change "recommended" to "minimum" #2451

merged 2 commits into from
Sep 4, 2024

Conversation

aeisenberg
Copy link
Contributor

The wording was causing confusion.

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.

@aeisenberg aeisenberg requested a review from a team as a code owner August 28, 2024 21:53
@rvermeulen
Copy link
Contributor

For posterity, following the recommendation and pinning the recommended version (e.g., v3.25.11) of the Action on a GHES instance that uses the CodeQL Action sync tool could lead to an error where the CodeQL bundle wasn't found because only the latest bundle (i.e., the default bundle for v3 at the time of syncing ) for the major version was synchronized.

@aeisenberg
Copy link
Contributor Author

Maybe we should explicitly state something like: we recommend pinning to the major version tag v3 even on GHES in order to get the most recent updates to the action.

Copy link
Contributor

@henrymercer henrymercer left a comment

Choose a reason for hiding this comment

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

I like the idea here. Couple of points:

  • How do we clarify that Enterprise Server 3.10 does not support CodeQL Action v3, because it does not support running Actions using Node 20? And Enterprise Server 3.11 only supports CodeQL Action v3 if you pull in v3 using GitHub Connect?
  • Does the Dotcom entry still make sense? It might be worth removing it.

@aeisenberg
Copy link
Contributor Author

  • How do we clarify that Enterprise Server 3.10 does not support CodeQL Action v3, because it does not support running Actions using Node 20? And Enterprise Server 3.11 only supports CodeQL Action v3 if you pull in v3 using GitHub Connect?

I'll add a new column "Notes" to add this info.

Does the Dotcom entry still make sense? It might be worth removing it.

No. Now that it is explicitly "minimum" version, I agree that this should be removed.

The wording was causing confusion.
henrymercer
henrymercer previously approved these changes Aug 30, 2024
README.md Outdated Show resolved Hide resolved
@aeisenberg aeisenberg merged commit 889597e into main Sep 4, 2024
310 checks passed
@aeisenberg aeisenberg deleted the aeisenberg/recommended branch September 4, 2024 19:49
@github-actions github-actions bot mentioned this pull request Sep 13, 2024
8 tasks
@dbartol dbartol mentioned this pull request Sep 13, 2024
8 tasks
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.

4 participants