Skip to content

Commit f1ad192

Browse files
tjtelantjtelan
committed
Check for null bytes before parsing (#17)
Fixes #16 Add tests for #16 Clippy + Rustfmt updates Return Errs and avoid panics Update CI w/ checks, caching Bump minor version to `0.4.0`
1 parent 6cb3b8d commit f1ad192

File tree

12 files changed

+186
-79
lines changed

12 files changed

+186
-79
lines changed

‎.github/release.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
changelog:
2+
exclude:
3+
labels:
4+
- ignore-for-release-notes
5+
- CI
6+
- CD
7+
- test
8+
- docs
9+
categories:
10+
- title: Breaking Changes 🛠
11+
labels:
12+
- Semver-Major
13+
- Semver-Minor
14+
- breaking-change
15+
- title: Exciting New Features 🎉
16+
labels:
17+
- Semver-Patch
18+
- enhancement
19+
- title: Bug Fixes
20+
labels:
21+
- bugfix
22+
- title: Other Changes
23+
labels:
24+
- "*"

‎.github/workflows/ci.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: git-url-parse
2+
3+
on:
4+
push:
5+
branches:
6+
- staging
7+
- trying
8+
pull_request:
9+
branches: [main]
10+
11+
env:
12+
CARGO_TERM_COLOR: always
13+
14+
jobs:
15+
ci:
16+
name: CI
17+
runs-on: ubuntu-latest
18+
strategy:
19+
matrix:
20+
cargo_checks:
21+
- name: Enforce default cargo fmt
22+
subcommand: fmt -- --check
23+
- name: Clippy
24+
subcommand: clippy
25+
- name: Test
26+
subcommand: test --verbose
27+
- name: Build
28+
subcommand: build --release --all-features --verbose
29+
steps:
30+
- uses: actions/checkout@v2
31+
- name: Stable with rustfmt and clippy
32+
uses: actions-rs/toolchain@v1
33+
with:
34+
profile: minimal
35+
toolchain: stable
36+
components: rustfmt, clippy
37+
- uses: Swatinem/rust-cache@v1
38+
- name: cargo check - ${{ matrix.cargo_checks.name }}
39+
run: cargo ${{ matrix.cargo_checks.subcommand }}
40+
done:
41+
name: Done
42+
if: github.event_name == 'push' && github.ref == 'refs/heads/staging'
43+
needs: [ci]
44+
runs-on: ubuntu-latest
45+
steps:
46+
- name: Done
47+
run: echo "Done!"

‎.github/workflows/publish.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Publish
2+
3+
on:
4+
# push:
5+
# branches: [master]
6+
workflow_dispatch:
7+
8+
jobs:
9+
publish:
10+
name: Publish to crates.io
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v2
14+
- uses: actions-rs/toolchain@v1
15+
with:
16+
toolchain: stable
17+
override: true
18+
- uses: katyo/publish-crates@v1
19+
with:
20+
registry-token: ${{ secrets.CARGO_REGISTRY_TOKEN }}

‎.github/workflows/rust.yml‎

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎CHANGELOG.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
# [0.4.0](https://github.com/tjtelan/git-url-parse-rs/compare/v0.3.1...v0.4.0)
2+
- Migrate to Rust 2021
3+
- Check for null bytes within input url before parsing (+ adding tests from [#16](https://github.com/tjtelan/git-url-parse-rs/issues/16))
4+
- Replace `anyhow` with `color-eyre`
5+
- Replace panic behavior with returning `Err()`
6+
- Update dependencies
7+
- Clippy/rustfmt fixes + add clippy/rustfmt checks to CI
8+
19
# [0.3.1](https://github.com/tjtelan/git-url-parse-rs/compare/v0.3.0...v0.3.1)
210
- Loosen dependency restrictions in `Cargo.toml` ([#12](https://github.com/tjtelan/git-url-parse-rs/issues/12))
311
- Update `strum` + `strum_macros` ([#14](https://github.com/tjtelan/git-url-parse-rs/issues/14))

‎Cargo.toml‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,21 @@ authors = ["T.J. Telan <[email protected]>"]
33
categories = ["parser-implementations", "encoding"]
44
description = "A parser for git repo urls based on url crate"
55
documentation = "https://docs.rs/git-url-parse"
6-
edition = "2018"
6+
edition = "2021"
77
keywords = ["git", "url", "parsing"]
88
license = "MIT"
99
name = "git-url-parse"
1010
readme = "README.md"
1111
repository = "https://github.com/tjtelan/git-url-parse-rs"
12-
version = "0.3.1"
13-
14-
[badges.maintenance]
15-
status = "actively-developed"
12+
version = "0.4.0"
1613

1714
[dependencies]
1815
log = "^0.4"
1916
url = "^2.2"
20-
strum = "^0.20"
21-
strum_macros = "^0.20"
22-
anyhow = "^1.0"
17+
strum = "^0.22"
18+
strum_macros = "^0.22"
19+
color-eyre = "^0.5"
2320
regex = "^1.4"
2421

2522
[dev-dependencies]
26-
env_logger = "^0.8"
23+
env_logger = "^0.9"

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# git-url-parse
22

33
[![Crates.io](https://img.shields.io/crates/v/git-url-parse)](https://crates.io/crates/git-url-parse)
4+
![Crates.io](https://img.shields.io/crates/d/git-url-parse)
5+
[![Github actions build status](https://github.com/tjtelan/git-url-parse-rs/workflows/git-url-parse/badge.svg)](https://github.com/tjtelan/git-url-parse-rs/actions/workflows/rust.yml)
46
[![docs.rs](https://docs.rs/git-url-parse/badge.svg)](https://docs.rs/git-url-parse/)
57
[![licence](https://img.shields.io/github/license/tjtelan/git-url-parse-rs)](LICENSE)
6-
![Github actions build status](https://github.com/tjtelan/git-url-parse-rs/workflows/git-url-parse/badge.svg)
8+
![Maintenance](https://img.shields.io/maintenance/yes/2021)
79

810
Supports common protocols as specified by the [Pro Git book](https://git-scm.com/book/en/v2)
911

‎bors.toml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
status = [
2+
"Done",
3+
]
4+
use_squash_merge = true
5+
delete_merged_branches = true
6+
timeout_sec = 900 # 15 mins

‎examples/multi.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use anyhow::Result;
1+
use color_eyre::Result;
22
use git_url_parse::GitUrl;
33

44
fn main() -> Result<()> {

‎examples/trim_auth.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use anyhow::Result;
1+
use color_eyre::Result;
22
use git_url_parse::GitUrl;
33

44
fn main() -> Result<()> {

0 commit comments

Comments
 (0)