Swift: Initial language guides documentation for Swift by geoffw0 · Pull Request #12940 · github/codeql

geoffw0 · 2023-04-26T17:50:09Z

Initial language guides documentation for Swift analysis. This is essentially a port of some of the language-specific documentation from other languages, though there are numerous small changes in the examples and specifics.

I'd like someone from the codeql-c-team to review this first, following the steps to make sure everything is clear and works correctly. After that I'll add a bit more polish, get a docs review, and we should check the links all work.

TODO:

team review
add the referenced images (basic-swift-query-results-1.png, basic-swift-query-results-2.png, quick-query-tab-swift.png)
add the referenced further reading doc (reusables/swift-further-reading.rst)
- https://github.com/github/codeql/tree/main/swift/ql/examples is currently a dead link --- added examples.
- https://codeql.github.com/codeql-standard-libraries/swift/ is currently a dead link --- should be checked later during staging.
check all markup and links work correctly
- there's a staging process for this.
add beta note(s)
doc review
when should we merge this?
- there is a correct time and branch this should be merged to so that the docs appear alongside public beta.

…les directory.

geoffw0 · 2023-05-02T16:59:10Z

You can preview the .rst files in the GitHub diff for this PR by clicking "..." > "View file". There are some dead links and missing graphics for now. But for the team review I'm really after feedback on the content, not the formatting.

MathiasVP

This looks really good! A couple of comments (both technical and non-technical).

Co-authored-by: Mathias Vorreiter Pedersen <mathiasvp@github.com>

…t.rst Co-authored-by: Mathias Vorreiter Pedersen <mathiasvp@github.com>

geoffw0 · 2023-05-03T13:50:10Z

Thanks for the detailed review @MathiasVP ! I think it's time I add those missing images and pass it over to the docs team (but feel free to make further comments if you wish to).

geoffw0 · 2023-05-05T16:40:28Z

I've added the three images. This is now ready for docs review.

I would also appreciate advice from the docs team about how to check all markup and links are correct, including what to do with the link to https://codeql.github.com/codeql-standard-libraries/swift/ (which doesn't currently exist). --- there is a staging process, we don't need to worry about this too much at this stage.

geoffw0 · 2023-05-05T16:46:24Z

Note that this screenshot shows a short snippet of source code from apple/swift-collections, similar to the versions of this image for other languages.

geoffw0 · 2023-05-10T10:35:14Z

Added the beta note. It will need referencing in a couple of other places in future, as we update other docs to include Swift.

…s.rst.

Co-authored-by: Felicity Chapman <felicitymay@github.com>

felicitymay

Thanks for writing up this content ✨

I've added a few small comments on the wording, but otherwise this looks ready to merge.

felicitymay · 2023-05-10T15:00:20Z

This can be merged into main once the tests are passing. Ideally this will be before the next CodeQL CLI release candidate branch is created (currently expected tomorrow).

Swift: Add Swift to supported-frameworks.rst, supported-versions-compilers.rst and extractors.rst

geoffw0 · 2023-05-10T16:45:40Z

I've just merged the contents of #13080 into this PR, as we want to check that CI passes on them together. The new commits have already been reviewed.

Co-authored-by: Felicity Chapman <felicitymay@github.com>

felicitymay

Thanks for the updates. This looks ready to merge from a docs point of view.

geoffw0 added 3 commits April 24, 2023 14:18

Swift: Add basic-query-for-swift-code.rst.

5f0d334

Swift: Add analyzing-data-flow-in-swift.rst

f2cb2b3

Swift: Minor edits.

5e7159f

geoffw0 added no-change-note-required This PR does not need a change note Swift labels Apr 26, 2023

github-actions Bot added documentation and removed Swift labels Apr 26, 2023

geoffw0 added 2 commits April 27, 2023 13:55

Swift: QLDoc consistency.

0885413

Swift: Add swift-further-reading.rst

e2e8e5d

github-actions Bot added the Swift label Apr 27, 2023

Swift: Add the four complete examples from the doc pages to the examp…

74274e8

…les directory.

github-advanced-security AI found potential problems Apr 27, 2023

View reviewed changes

Comment thread swift/ql/examples/snippets/simple_constant_password.ql Fixed

Comment thread swift/ql/examples/snippets/simple_sql_injection.ql Fixed

Comment thread swift/ql/examples/snippets/simple_sql_injection.ql Fixed

Swift: Address singleton set literal warning

837f16c

MathiasVP reviewed May 3, 2023

View reviewed changes

geoffw0 and others added 5 commits May 3, 2023 13:31

Apply suggestions from code review

2fd8b87

Co-authored-by: Mathias Vorreiter Pedersen <mathiasvp@github.com>

Swift: Correct a couple more cases.

1084d7f

Swift: Mathias's fix for the non-constant format example.

2999b5f

Swift: Fix the versions in 'examples' as well.

02dc9be

Update docs/codeql/codeql-language-guides/analyzing-data-flow-in-swif…

02ae44a

…t.rst Co-authored-by: Mathias Vorreiter Pedersen <mathiasvp@github.com>

Swift: Add images.

850686a

geoffw0 added the ready-for-doc-review This PR requires and is ready for review from the GitHub docs team. label May 5, 2023

geoffw0 commented May 5, 2023

View reviewed changes

geoffw0 added 5 commits May 5, 2023 17:55

Swift: Add necessary .yml files.

3315fd2

Swift: Fix Sphinx / Docs error.

aa8aa0b

Swift: Fix more underline length issues.

0ab8947

Swift: Optimize the graphics.

9618c61

Swift: Add Swift to supported-frameworks.rst

fc40673

geoffw0 added 2 commits May 9, 2023 10:37

Swift: Update supported-versions-compilers.rst

0d1df81

Swift: Add missing link.

d278340

geoffw0 marked this pull request as ready for review May 9, 2023 10:07

geoffw0 requested a review from a team as a code owner May 9, 2023 10:07

geoffw0 added 3 commits May 10, 2023 11:02

Swift: Update extractors.rst

68c16c4

Swift: Add footnote in supported-versions-compilers.rst

9d7ba3a

Swift: Add beta note to these docs.

beb3759

Swift: Add a link to the swift-beta-note.rst from supported-framework…

29f542b

…s.rst.

felicitymay mentioned this pull request May 10, 2023

Minor docs updates for Swift public beta #13107

Merged

geoffw0 and others added 2 commits May 10, 2023 15:40

Update docs/codeql/reusables/supported-versions-compilers.rst

f02c1ed

Co-authored-by: Felicity Chapman <felicitymay@github.com>

Merge branch 'main' into swiftdoc

81c2979

geoffw0 mentioned this pull request May 10, 2023

Swift: Add Swift to supported-frameworks.rst, supported-versions-compilers.rst and extractors.rst geoffw0/ql#4

Merged

felicitymay previously approved these changes May 10, 2023

View reviewed changes

Merge pull request #4 from geoffw0/swiftdoc3

f1fb3e1

Swift: Add Swift to supported-frameworks.rst, supported-versions-compilers.rst and extractors.rst

geoffw0 dismissed felicitymay’s stale review via f1fb3e1 May 10, 2023 16:43

geoffw0 mentioned this pull request May 10, 2023

Swift: Add Swift to supported-frameworks.rst, supported-versions-compilers.rst and extractors.rst #13080

Closed

5 tasks

Apply suggestions from code review

c92e8dc

Co-authored-by: Felicity Chapman <felicitymay@github.com>

felicitymay approved these changes May 10, 2023

View reviewed changes

geoffw0 merged commit 100d960 into github:main May 10, 2023

geoffw0 mentioned this pull request May 16, 2023

Swift: Mirror changes made in the tutorial docs. #13184

Merged

Conversation

geoffw0 commented Apr 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

geoffw0 commented May 2, 2023

Uh oh!

MathiasVP left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

geoffw0 commented May 3, 2023

Uh oh!

geoffw0 commented May 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

geoffw0 May 5, 2023

Choose a reason for hiding this comment

Uh oh!

geoffw0 commented May 10, 2023

Uh oh!

felicitymay left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

felicitymay commented May 10, 2023

Uh oh!

geoffw0 commented May 10, 2023

Uh oh!

felicitymay left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

geoffw0 commented Apr 26, 2023 •

edited

Loading

geoffw0 commented May 5, 2023 •

edited

Loading