|
1 | | -# codeql-extractor-action |
| 1 | +<!-- markdownlint-disable --> |
| 2 | +<div align="center"> |
| 3 | +<h1>CodeQL Extractor Action</h1> |
2 | 4 |
|
3 | | -CodeQL Extractor Action. |
| 5 | +[][github] |
| 6 | +[][github-actions] |
| 7 | +[][github-issues] |
| 8 | +[][github] |
| 9 | +[][license] |
| 10 | + |
| 11 | +</div> |
| 12 | +<!-- markdownlint-restore --> |
| 13 | + |
| 14 | +## Overview |
| 15 | + |
| 16 | +[CodeQL Extractor Action][github] is a GitHub Action that helps none-GitHub [CodeQL] Extractor to integrate with GitHub Actions. |
| 17 | + |
| 18 | +## ✨ Features |
| 19 | + |
| 20 | +- **Easy to use**: The action is designed to be simple and easy to integrate into your existing GitHub Actions workflows. |
| 21 | +- **End-to-end workflow**: The action provides end-to-end workflow for extracting code from your repository and running CodeQL analysis. |
| 22 | +- **Customizable**: The action allows you to customize the extraction process to fit your specific needs. |
4 | 23 |
|
5 | 24 | ## Usage |
6 | 25 |
|
7 | 26 | ```yml |
8 | 27 | - name: "CodeQL Extractor Action" |
9 | 28 | uses: advanced-security/[email protected] |
| 29 | + with: |
| 30 | + # Repository reference (e.g. "owner/repo", "owner/repo@ref") |
| 31 | + extractor: "advanced-security/[email protected]" |
| 32 | + # [optional] Attest the authenticity of the extractor |
| 33 | + attestation: true |
10 | 34 | ``` |
11 | 35 |
|
| 36 | +> !WARNING |
| 37 | +> This action downloads the extractor from the GitHub repository. Make sure to use a trusted repository, owner, and extractor. |
| 38 | +
|
| 39 | +## License |
| 40 | +
|
| 41 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
| 42 | +
|
| 43 | +<!-- Resoucres --> |
| 44 | +
|
| 45 | +[license]: ./LICENSE |
| 46 | +[github]: https://github.com/advanced-security/codeql-extractor-action |
| 47 | +[github-issues]: https://github.com/advanced-security/codeql-extractor-action/issues |
| 48 | +[github-actions]: https://github.com/advanced-security/codeql-extractor-action/actions |
| 49 | +
|
| 50 | +[CodeQL]: https://codeql.github.com/ |
0 commit comments