StanfordSpezi / SpeziKt

Kotlin & Android Version of the Stanford Spezi Framework
http://spezi.health/SpeziKt/
MIT License
7 stars 1 forks source link

Create codeql-analysis.yml #19

Closed eldcn closed 1 month ago

eldcn commented 1 month ago

CodeQL Analysis

Adds CodeQL workflow based on the default config proposed from Github

:recycle: Current situation & Problem

Link any open issues or pull requests (PRs) related to this PR. Please ensure that all non-trivial PRs are first tracked and discussed in an existing GitHub issue or discussion.

:gear: Release Notes

Add a bullet point list summary of the feature and possible migration guides if this is a breaking change so this section can be added to the release notes. Include code snippets that provide examples of the feature implemented or links to the documentation if it appends or changes the public interface.

:books: Documentation

Please ensure that you properly document any additions in conformance to Spezi Documentation Guide. You can use this section to describe your solution, but we encourage contributors to document your reasoning and changes using in-line documentation.

:white_check_mark: Testing

Please ensure that the PR meets the testing requirements set by CodeCov and that new functionality is appropriately tested. This section describes important information about the tests and why some elements might not be testable.

:pencil: Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

github-advanced-security[bot] commented 1 month ago

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

eldcn commented 1 month ago

Since CodeQL requires project build, and as part of Detekt https://github.com/StanfordSpezi/SpeziKt/pull/18 I have splitted the workflows, I integrated CodeQL steps there: https://github.com/StanfordSpezi/SpeziKt/pull/18/files#diff-a0fe23534b616d51ce686d2a1bcd1a78bc75074aef1a2f6ee96c9469991e1a4c

Hence closing this pull request on favor https://github.com/StanfordSpezi/SpeziKt/pull/18