Skip to content

Document GitHub Actions support / Add rust support #16

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.

Sign up for GitHub

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
felickz merged 5 commits into from
Jul 3, 2025
Merged

Document GitHub Actions support / Add rust support #16

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
403b7c7
Update main.py to add debug prints
felickz Jul 3, 2025
0933d96
docs: Add section on GitHub Actions support for CodeQL analysis
felickz Jul 3, 2025
6aae72b
docs: Add contributing guidelines and versioning instructions to the …
felickz Jul 3, 2025
9b2af5e
Add .gitattributes file here for future use cases
felickz Jul 3, 2025
a95d2a1
fix: Add 'rust' to the list of supported CodeQL languages
felickz Jul 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,19 @@ Example:

```

### Actions support

The GitHub API for [List repository languages](https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#list-repository-languages) does not by default include "YAML"/"GitHub Actions". This is particularly useful if your repository contains GitHub Actions workflows that you want to include in CodeQL analysis.

To add support for this to your repo, you must add a `.gitattributes` file with the following contents:

```
.github/workflows/*.yml linguist-detectable -linguist-vendored
.github/workflows/*.yaml linguist-detectable -linguist-vendored
```

These directives tell GitHub's linguist to detect YAML files in the `.github/workflows/` directory as a language and not treat them as vendored code, making them visible in the repository languages API.

### Swift support
If you want to include Swift in your CodeQL analysis, you need to ensure that the action runs on a macOS runner. This is because Swift analysis with CodeQL requires a macOS environment. You can achieve this by making the `runs-on` field in your workflow conditional based on the language being analyzed.

Expand Down
4 changes: 2 additions & 2 deletions main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ def build_languages_list(languages):
languages[i] = ("javascript")
if languages[i] == "kotlin":
languages[i] = ("java")
# GitHub Actions
if languages[i] == "yaml":
languages[i] = ("actions")

print("After mapping:", languages)
Comment thread
felickz marked this conversation as resolved.
intersection = list(set(languages) & set(codeql_languages))
print("Intersection:", intersection)
return intersection

# return a list of objects from language list if they are not in the exclude list
Expand Down