Skip to content

Rename isPOD to isPod to silence deprecation warnings #70

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 1 commit into from
Aug 26, 2022

Conversation

erik-krogh
Copy link
Contributor

@erik-krogh erik-krogh commented Aug 25, 2022

Description

This PR targets the next branch.

I want to rename a bunch of acronyms to use camelCase/PascalCase to follow our own style guide for QL.
(See this draft PR: github/codeql#10153).

When I do that 4 tests in this repo start to fail because of deprecation warnings because if the idPOD() predicate.
I'll let them fail for now, and after I've merged the semmle-code PR I'll fix the deprecation warnings.

The change in this PR will apply from CodeQL 2.11.0 onwards.

Change request type

  • Query files (.ql, .qll, .qls or unit tests)

Rules with added or modified queries

  • No rules added

Release change checklist

A change note (development_handbook.md#change-notes) is required for any pull request which modifies:

  • The structure or layout of the release artifacts.
  • The evaluation performance (memory, execution time) of an existing query.
  • The results of an existing query in any circumstance.

If you are only adding new rule queries, a change note is not required.

Author: Is a change note required?

  • Yes
  • No

Reviewer: Confirm that either a change note is not required or the change note is required and has been added.

  • Confirmed

@lcartey
Copy link
Collaborator

lcartey commented Aug 25, 2022

I think we would be better changing our use of isPOD to isPod on the next branch, rather than trying put workarounds in here. @jketema what do you think?

@erik-krogh
Copy link
Contributor Author

I think we would be better changing our use of isPOD to isPod on the next branch, rather than trying put workarounds in here. @jketema what do you think?

It's a chicken and egg problem.
I haven't renamed isPOD to isPoD in github/codeql yet.
But in order to do that, I need the coding standard tests on our internal repo to pass.
And for that to happen I need there to be no deprecation warnings in query files in this repo.

So I think something like this PR is the only solution.

We can change it to your suggestion afterwards when the isPOD -> isPoD rename has been merged.

@erik-krogh erik-krogh marked this pull request as ready for review August 25, 2022 07:53
@jketema
Copy link
Collaborator

jketema commented Aug 25, 2022

The policy is that the internal coding standards tests may temporarily be broken while we're in the middle for fixing things. So the breakage there is no problem. It should not be blocking merging, if it does we have configured something wrongly.

So I agree with @lcartey that we do not need a workaround. That does mean that the CI here will temporarily break until we update to the next release on the next branch, but that should also not considered to be blocking.

@jketema
Copy link
Collaborator

jketema commented Aug 25, 2022

TL;DR: Just rename isPOD to isPod and let us know when the internal CI checks should be expected to be green again.

@jketema
Copy link
Collaborator

jketema commented Aug 25, 2022

Also, yes, this should target next and not main as next is the branch we use in internal testing.

@erik-krogh erik-krogh changed the base branch from main to next August 25, 2022 08:40
@erik-krogh erik-krogh force-pushed the isPodDep branch 2 times, most recently from b73275c to 857d974 Compare August 25, 2022 08:43
@erik-krogh erik-krogh marked this pull request as draft August 25, 2022 08:43
@jketema jketema changed the title avoid future idPOD deprecation warnings Rename isPOD to isPod to silence deprecation warnings Aug 26, 2022
@erik-krogh
Copy link
Contributor Author

I've merged the github/codeql and semmle-code PRs that do the rename from isPOD() to isPod().
Now I think we just wait for the next release that includes that rename.

@jketema jketema marked this pull request as ready for review August 26, 2022 09:01
@jketema
Copy link
Collaborator

jketema commented Aug 26, 2022

Merging this now to get the internal CI up and running again. We'll fix the one here when 2.11.0 gets released.

@jketema jketema merged commit 0619dce into github:next Aug 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

3 participants