Improve codeql action #78
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -32,8 +32,13 @@ jobs: | |||||
| with: | ||||||
| submodules: recursive | ||||||
|
|
||||||
| - name: Install nightly toolchain | ||||||
| run: | | ||||||
| rustup toolchain install nightly --profile minimal | ||||||
| rustup component add rustfmt --toolchain nightly | ||||||
|
|
||||||
| - name: Run rustfmt | ||||||
| run: cargo +nightly fmt --all --check | ||||||
|
|
||||||
| clippy: | ||||||
| name: Clippy Check | ||||||
|
|
@@ -43,6 +48,7 @@ jobs: | |||||
| pull-requests: write | ||||||
| env: | ||||||
| CARGO_TERM_COLOR: always | ||||||
| RUSTUP_TOOLCHAIN: stable | ||||||
|
|
||||||
| steps: | ||||||
| - name: Checkout repository | ||||||
|
|
@@ -51,12 +57,16 @@ jobs: | |||||
| submodules: recursive | ||||||
|
|
||||||
| - name: Run cargo clippy | ||||||
| run: cargo clippy --all-targets --all-features -- -D warnings | ||||||
|
|
||||||
| redundancy: | ||||||
| name: Redundancy Check | ||||||
| runs-on: [ self-hosted ] | ||||||
|
|
||||||
| env: | ||||||
| CARGO_TERM_COLOR: always | ||||||
| RUSTUP_TOOLCHAIN: stable | ||||||
|
|
||||||
| steps: | ||||||
| - name: Checkout repository | ||||||
| uses: actions/checkout@v4 | ||||||
|
|
@@ -82,6 +92,10 @@ jobs: | |||||
|
|
||||||
| runs-on: [ self-hosted ] | ||||||
|
|
||||||
| env: | ||||||
| CARGO_TERM_COLOR: always | ||||||
| RUSTUP_TOOLCHAIN: stable | ||||||
|
|
||||||
| steps: | ||||||
| - name: Checkout repository | ||||||
| uses: actions/checkout@v4 | ||||||
|
|
@@ -97,6 +111,7 @@ jobs: | |||||
| runs-on: [ self-hosted ] | ||||||
| env: | ||||||
| CARGO_TERM_COLOR: always | ||||||
| RUSTUP_TOOLCHAIN: stable | ||||||
|
|
||||||
| steps: | ||||||
| - name: Checkout repository | ||||||
|
|
@@ -106,4 +121,4 @@ jobs: | |||||
| lfs: true | ||||||
|
|
||||||
| - name: Run cargo test | ||||||
| run: git lfs pull && cargo test --all | ||||||
|
There was a problem hiding this comment. This line appears unchanged in the diff (no '+' or '-' marker on line 123), but the diff shows it was touched. The actual change appears to be whitespace-only or formatting. If no functional change was intended, consider ensuring the file wasn't accidentally modified. There was a problem hiding this comment. Consider adding a newline at the end of this file following POSIX standards. Many tools expect text files to end with a newline character.
Suggested change
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -1,6 +1,6 @@ | ||||||||
| [package] | ||||||||
| name = "git-internal" | ||||||||
| version = "0.4.1" | ||||||||
| edition = "2024" | ||||||||
| license = "MIT" | ||||||||
| description = "Git-Internal is a high-performance Rust library for encoding and decoding Git internal objects and Pack files." | ||||||||
|
|
@@ -28,7 +28,7 @@ encoding_rs = "0.8.35" | |||||||
| rayon = "1.11.0" | ||||||||
| ahash = "0.8.12" | ||||||||
| diffs = "0.5.1" | ||||||||
| libc = "0.2.180" | ||||||||
| async-trait = "0.1.89" | ||||||||
| futures = "0.3.31" | ||||||||
| tokio-stream = "0.1.18" | ||||||||
|
|
@@ -40,9 +40,9 @@ sha2 = "0.10.9" | |||||||
| crc32fast = "1.4" | ||||||||
|
There was a problem hiding this comment. The version specifier was changed from '2.0.16+zstd.1.5.7' to '2.0.16', removing the build metadata. While this may work, the original version string included important information about the bundled zstd version (1.5.7). Consider adding a comment to document which zstd version this corresponds to for future maintainability.
Suggested change
|
||||||||
| zstd-sys = { version = "2.0.16+zstd.1.5.7", features = ["experimental"] } | ||||||||
| sea-orm = { version = "1.1.17", features = ["sqlx-sqlite"] } | ||||||||
| flate2 = { version = "1.1.8", features = ["zlib"] } | ||||||||
| serde = { version = "1.0.228", features = ["derive"] } | ||||||||
| chrono = { version = "0.4.43", features = ["serde"] } | ||||||||
| uuid = { version = "1.19.0", features = ["v4"] } | ||||||||
| tokio = { version = "1.49.0", features = ["fs", "io-util"] } | ||||||||
| bincode = { version = "2.0.1", features = ["serde"] } | ||||||||
|
|
||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -151,3 +151,55 @@ A simple approach: | |
| ### Benchmark | ||
|
|
||
| **TODO** | ||
|
|
||
| ## Contributing | ||
|
|
||
| ### Pre-submission Checks | ||
|
|
||
| Before submitting a Pull Request, please ensure your code passes the following checks: | ||
|
|
||
| ```bash | ||
| # Run clippy with all warnings treated as errors (warnings will be treated as errors) | ||
| cargo clippy --all-targets --all-features -- -D warnings | ||
|
There was a problem hiding this comment. The README states 'Both commands must complete without any errors or warnings' but using |
||
|
|
||
| # Check code formatting (requires nightly toolchain) | ||
| cargo +nightly fmt --all --check | ||
| ``` | ||
|
|
||
| **Both commands must complete without any warnings.** The clippy check treats all warnings as errors, and the formatter check ensures code follows the project style guide. Only PRs that pass these checks will be accepted for merge. | ||
|
|
||
| If the formatting check fails, you can automatically fix formatting issues by running: | ||
|
|
||
| ```bash | ||
| cargo +nightly fmt --all | ||
| ``` | ||
|
|
||
| ### Buck2 Build Requirements | ||
|
|
||
| This project builds with Buck2. Please install both Buck2 and `cargo-buckal` before development: | ||
|
|
||
| ```bash | ||
| # Install buck2: download the latest release tarball from | ||
| # https://github.com/facebook/buck2/releases, extract the binary, | ||
| # and place it in ~/.cargo/bin (ensure ~/.cargo/bin is on PATH). | ||
| # Example (replace <tag> and <platform> with the latest for your OS): | ||
| wget https://github.com/facebook/buck2/releases/download/<tag>/buck2-<platform>.tar.gz | ||
| tar -xzf buck2-<platform>.tar.gz | ||
| mv buck2 ~/.cargo/bin/ | ||
|
|
||
| # Install cargo-buckal (requires Rust toolchain) | ||
| cargo install --git https://github.com/buck2hub/cargo-buckal.git | ||
| ``` | ||
|
|
||
| Pull Requests must also pass the Buck2 build: | ||
|
|
||
| ```bash | ||
| cargo buckal build | ||
| ``` | ||
|
|
||
| When you update dependencies in Cargo.toml, regenerate Buck metadata and third-party lockfiles: | ||
|
|
||
| ```bash | ||
| cargo buckal migrate | ||
| ``` | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The clippy command now includes
--all-targetswhich will check tests, benches, examples, and all other targets. This is good for comprehensive coverage, but be aware it may catch issues in code that wasn't previously checked. Consider mentioning this expanded scope in the PR description to set expectations.