Skip to content

Commit 039fce7

Browse files
committed
feaT: Updates to README, release and other files
1 parent bbcd1aa commit 039fce7

File tree

5 files changed

+44
-6
lines changed

5 files changed

+44
-6
lines changed

.github/workflows/self-action.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,4 @@ jobs:
1919
uses: ./
2020
with:
2121
token: ${{ secrets.GITHUB_TOKEN }}
22-
extractor_repository: ${{ env.EXTRACTOR_REPOSITORY }}
23-
22+
extractor: ${{ env.EXTRACTOR_REPOSITORY }}

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11

22
.env
33
target/
4+
extractors/

.release.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,3 @@ version: 0.1.0
55
ecosystems:
66
- Docs
77
- Rust
8-

README.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,50 @@
1-
# codeql-extractor-action
1+
<!-- markdownlint-disable -->
2+
<div align="center">
3+
<h1>CodeQL Extractor Action</h1>
24

3-
CodeQL Extractor Action.
5+
[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)][github]
6+
[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/advanced-security/codeql-extractor-action/main.yml?style=for-the-badge)][github-actions]
7+
[![GitHub Issues](https://img.shields.io/github/issues/advanced-security/codeql-extractor-action?style=for-the-badge)][github-issues]
8+
[![GitHub Stars](https://img.shields.io/github/stars/advanced-security/codeql-extractor-action?style=for-the-badge)][github]
9+
[![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)][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.
423

524
## Usage
625

726
```yml
827
- name: "CodeQL Extractor Action"
928
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
1034
```
1135
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/

action.Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
FROM gcr.io/advanced-security/codeql-extractor-action:latest
1+
FROM gcr.io/advanced-security/codeql-extractor-action:v0.1.0
22

33
ENTRYPOINT [ "codeql-extractor-action" ]

0 commit comments

Comments
 (0)