Skip to content

Commit

Permalink
fix(ci): Fix CI release workflow (#25)
Browse files Browse the repository at this point in the history
  • Loading branch information
tsengia authored Dec 28, 2023
2 parents d7a1deb + 1dd3d39 commit 5624f1c
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 15 deletions.
9 changes: 4 additions & 5 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,7 @@ Cargo.lock
# Ignore code coverage profiling output
*.profraw

*~
*~

# Ignore any spidercrab-ignore files
.spidercrab-ignore
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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] <url>
Usage: spider-crab.exe [OPTIONS] <url>
Arguments:
<url> URL of the webpage to check.
Options:
-d, --depth <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 <dot> Save output to file in graphiz Dot format.
-h, --help Print help
-V, --version Print version
```

Example:
Expand All @@ -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!
Expand All @@ -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
Expand Down

0 comments on commit 5624f1c

Please sign in to comment.