Skip to content

C++: Deprecate AST dataflow#13621

Merged
jketema merged 5 commits intogithub:mainfrom
MathiasVP:deprecate-ast-dataflow
Jul 18, 2023
Merged

C++: Deprecate AST dataflow#13621
jketema merged 5 commits intogithub:mainfrom
MathiasVP:deprecate-ast-dataflow

Conversation

@MathiasVP
Copy link
Contributor

@MathiasVP MathiasVP commented Jun 29, 2023

All of our queries use IR dataflow now (hopefully!).

@MathiasVP MathiasVP requested a review from a team as a code owner June 29, 2023 14:14
@github-actions github-actions bot added the C++ label Jun 29, 2023
@jketema
Copy link
Contributor

jketema commented Jun 29, 2023

I think the micro-site docs need to be updated as part to this to say that the library is deprecated (not that we're going to deprecate it at some point). Also some tests will probably fail, because they'll now include a deprecation warning.

@MathiasVP
Copy link
Contributor Author

I think the micro-site docs need to be updated as part to this to say that the library is deprecated (not that we're going to deprecate it at some point).

Good point. I guess we'll simply change the wording in https://github.com/github/codeql/blob/main/docs/codeql/codeql-language-guides/analyzing-data-flow-in-cpp.rst, right?

Also some tests will probably fail, because they'll now include a deprecation warning.

Yeah, I think it's fine to just accept these. Then we can delete those annotations completely once we delete the library.

@jketema
Copy link
Contributor

jketema commented Jun 29, 2023

I think the micro-site docs need to be updated as part to this to say that the library is deprecated (not that we're going to deprecate it at some point).

Good point. I guess we'll simply change the wording in https://github.com/github/codeql/blob/main/docs/codeql/codeql-language-guides/analyzing-data-flow-in-cpp.rst, right?

Yes.

Also some tests will probably fail, because they'll now include a deprecation warning.

Yeah, I think it's fine to just accept these. Then we can delete those annotations completely once we delete the library.

Agreed.

@jketema
Copy link
Contributor

jketema commented Jun 29, 2023

Oh yeah, coding standards 😭

@MathiasVP
Copy link
Contributor Author

😭

@rvermeulen
Copy link
Contributor

rvermeulen commented Jun 30, 2023

Coding standards is pinned to a CodeQL CLI and standard library version. What is the expected deprecation timeline. Last time it was around a year I believe.

/cc @lcartey

@jketema
Copy link
Contributor

jketema commented Jun 30, 2023

Coding standards is pinned to a CodeQL CLI and standard library version.

Indeed, but the next branch which we test against isn't, and that's causing problems here. Of course that branch exists to catch these kinds of problems early.

@MathiasVP
Copy link
Contributor Author

Last time it was around a year I believe.

Correct 🙂

@jketema
Copy link
Contributor

jketema commented Jul 11, 2023

I believe we can move forward with this, and we just have to update the test results on the coding standards next branch to include the deprecation warnings.

@MathiasVP
Copy link
Contributor Author

I believe we can move forward with this, and we just have to update the test results on the coding standards next branch to include the deprecation warnings.

Thanks for the ping. I'll update the test results on this branch later today 👍.

@MathiasVP MathiasVP added the ready-for-doc-review This PR requires and is ready for review from the GitHub docs team. label Jul 17, 2023
@MathiasVP
Copy link
Contributor Author

This PR is ready for a docs review. Documentation friends: Would you please review the changes to the analyzing-data-flow-in-cpp.rst file?

Copy link

@jhosman jhosman left a comment

Choose a reason for hiding this comment

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

The text changes in analyzing-data-flow-in-cpp.rst look good! 👍

@jketema jketema merged commit a426010 into github:main Jul 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C++ documentation ready-for-doc-review This PR requires and is ready for review from the GitHub docs team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants