From 6d73df20095746d683bfd1fc5fdee4c4a4390b56 Mon Sep 17 00:00:00 2001 From: Tyler Sengia Date: Wed, 27 Dec 2023 22:18:09 -0500 Subject: [PATCH 1/4] fix(git): Ignore spidercrab-ignore files in git --- .gitignore | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index a7e3775..ccf2dd1 100644 --- a/.gitignore +++ b/.gitignore @@ -19,4 +19,7 @@ Cargo.lock # Ignore code coverage profiling output *.profraw -*~ \ No newline at end of file +*~ + +# Ignore any spidercrab-ignore files +.spidercrab-ignore \ No newline at end of file From 03057a3613c4af5ec94ce1895f4e62ae23a3515c Mon Sep 17 00:00:00 2001 From: Tyler Sengia Date: Wed, 27 Dec 2023 22:31:17 -0500 Subject: [PATCH 2/4] docs: Update README with latest help message and fix white spacing --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index bf3478e..000010a 100644 --- a/README.md +++ b/README.md @@ -15,17 +15,17 @@ If Spider Crab finds the following, then it will return a non-zero exit code: If Spider Crab does not find any issues, then it will return a `0` exit code. ``` -Usage: spider-crab [OPTIONS] +Usage: spider-crab.exe [OPTIONS] Arguments: URL of the webpage to check. Options: -d, --depth Depth of links to check. Default is -1 which is unlimited. [default: -1] - -q, --quiet Do not print to STDOUT or STDERR. - -v, --verbose Print more log messages. Append additional 'v' characters to increase verbosity. + -q Silence logging output. + -v... Print more log messages. + -o, --dot Save output to file in graphiz Dot format. -h, --help Print help - -V, --version Print version ``` Example: @@ -44,11 +44,11 @@ Example: ``` ## Suppressing Errors -If you want to ignore specific errors on specific pages, then you can write a `.spidercrab-ignore` file and place it in your working directory. -When spider-crab launches, it will read the file line by line for a `ignore-rule target-url` pairing, separated by any amount whitespace. +If you want to ignore specific errors on specific pages, then you can write a `.spidercrab-ignore` file and place it in your working directory. +When spider-crab launches, it will read the file line by line for a `ignore-rule target-url` pairing, separated by any amount whitespace. Lines starting with a `#` are comments and will be ignored. -The names of rules to ignore are printed between the parenthesis `()` of an error report when you run spider crab. +The names of rules to ignore are printed between the parenthesis `()` of an error report when you run spider crab. For example, to ignore this error: ``` ERROR - SpiderError (missing-title): Page at "https://example-page.com/somewhere/something.html" does not have a title! @@ -59,7 +59,7 @@ missing-title https://example-page.com/somewhere/something.html ``` -Example `.spidercrab-ignore` file: +Here is a more complete example of an `.spidercrab-ignore` file: ``` # This line is a comment # Ignore that this page doesn't have a title. It's an archived page that we won't fix due to historic reasons From 0e619afc0d0dc0e08eeeb983a6b42db74b7ba5a3 Mon Sep 17 00:00:00 2001 From: Tyler Sengia Date: Wed, 27 Dec 2023 22:48:34 -0500 Subject: [PATCH 3/4] fix(ci): Switch to ncipollo/release-action --- .github/workflows/release.yml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index e249790..69098b4 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -19,10 +19,9 @@ jobs: - name: Build run: cargo build --release --locked - name: Upload - uses: svenstaro/upload-release-action@v1-release + uses: ncipollo/release-action@v1 with: - repo_token: ${{ secrets.SPIDER_CRAB_TOKEN }} - file: target/release/spider-crab - asset_name: spider-crab-linux-amd64 + token: ${{ secrets.SPIDER_CRAB_TOKEN }} + artifacts: target/release/spider-crab tag: ${{ github.ref }} - overwrite: false + allowUpdates: false From 1dd3d39be5ddd7653e92bdf6924f914d8288f61d Mon Sep 17 00:00:00 2001 From: Tyler Sengia Date: Wed, 27 Dec 2023 22:48:50 -0500 Subject: [PATCH 4/4] chore: Bump Cargo.toml version number --- Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 64804b9..115d715 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "spider-crab" -version = "0.1.0" +version = "0.1.1" edition = "2021" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html