Skip to content

Commit e894c41

Browse files
authored
Merge pull request #11 from advanced-security/project-update
Project update
2 parents 6a20966 + 0a658ca commit e894c41

File tree

6 files changed

+335
-187
lines changed

6 files changed

+335
-187
lines changed

.github/CODEOWNERS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# This project is maintained with love by:
2+
3+
* @advanced-security/oss-maintainers

.github/dependabot.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "cargo"
9+
directory: "/"
10+
schedule:
11+
interval: "weekly"
12+
reviewers:
13+
- "advanced-security/oss-maintainers"
14+
groups:
15+
extractor:
16+
dependency-type: "production"
17+
18+
- package-ecosystem: "github-actions"
19+
directory: "/"
20+
schedule:
21+
interval: "weekly"
22+
reviewers:
23+
- "advanced-security/oss-maintainers"
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
applyTo: '**/*.rs'
3+
---
4+
5+
This is a GitHub Action that allows you to specify a CodeQL extractor to be used in your workflows as an author of an Extractor.
6+
It is designed to be used in conjunction with the [CodeQL][CodeQL] analysis tool, which is a powerful static analysis tool that can be used to find vulnerabilities in your code.
7+
8+
The project is written in Rust and used the [ghactions](https://crates.io/crates/ghactions) crate to simplify the development of GitHub Actions in Rust.
9+
The action is built using a Debian based Docker image.
10+
11+
## Guidelines
12+
13+
- Use cargo fmt to format the code.
14+
- Use cargo clippy to lint the code.
15+
- Always write documentation for public functions and modules.
16+
- Write unit tests for all public functions.
17+
- Use `log::info!`, `log::warn!`, `log::error!` for logging.
18+
19+
## Testing
20+
21+
You can test the Rust code locally using `cargo test`.
22+
23+
```sh
24+
cargo test
25+
```
26+
27+
This will run all the tests in the project and display the results in the terminal.
28+
Validate the output of the tests to ensure that everything is working as expected.
29+
If the tests fail, debug the code and fix any issues before proceeding.

0 commit comments

Comments
 (0)