Merge commit '32edc9b8e5aa8f3151b761f635a205679e1e29f4' into future-main

tjtelan · tjtelan · commit 62ce79f4f8b7 · 2024-08-22T18:04:17.000-07:00
diff --git a/.github/release.yml b/.github/release.yml
@@ -0,0 +1,24 @@
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release-notes
+      - CI
+      - CD
+      - test
+      - docs
+  categories:
+    - title: Breaking Changes 🛠
+      labels:
+        - Semver-Major
+        - Semver-Minor
+        - breaking-change
+    - title: Exciting New Features 🎉
+      labels:
+        - Semver-Patch
+        - enhancement
+    - title: Bug Fixes
+      labels:
+        - bugfix
+    - title: Other Changes
+      labels:
+        - "*"
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,48 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - staging
+      - trying
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  ci:
+    name: CI
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        cargo_checks:
+          - name: Enforce default cargo fmt
+            subcommand: fmt -- --check
+          - name: Clippy
+            subcommand: clippy
+          - name: Test
+            subcommand: test --verbose
+          - name: Build
+            subcommand: build --release --all-features --verbose
+    steps:
+    - uses: actions/checkout@v2
+    - name: Stable with rustfmt and clippy
+      uses: actions-rs/toolchain@v1
+      with:
+        profile: minimal
+        toolchain: stable
+        components: rustfmt, clippy
+    - uses: Swatinem/rust-cache@v1
+    - name: cargo check - ${{ matrix.cargo_checks.name }} 
+      run: cargo ${{ matrix.cargo_checks.subcommand }}
+  done:
+    name: Done
+    if: github.event_name == 'push' && github.ref == 'refs/heads/staging'
+    needs: [ci]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Done
+        run: echo "Done!"
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,20 @@
+name: Publish
+
+on:
+#  push:
+#    branches: [master]
+  workflow_dispatch:
+
+jobs:
+  publish:
+    name: Publish to crates.io
+    runs-on: ubuntu-latest
+    steps:
+        - uses: actions/checkout@v2
+        - uses: actions-rs/toolchain@v1
+          with:
+              toolchain: stable
+              override: true
+        - uses: katyo/publish-crates@v1
+          with:
+              registry-token: ${{ secrets.CARGO_REGISTRY_TOKEN }}
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,29 +1,37 @@
+# [0.4.0](https://github.com/tjtelan/git-url-parse-rs/compare/v0.3.1...v0.4.0)
+- Migrate to Rust 2021
+- Check for null bytes within input url before parsing (+ adding tests from [#16](https://github.com/tjtelan/git-url-parse-rs/issues/16))
+- Replace `anyhow` with `color-eyre`
+- Replace panic behavior with returning `Err()`
+- Update dependencies
+- Clippy/rustfmt fixes + add clippy/rustfmt checks to CI
+
 # [0.3.1](https://github.com/tjtelan/git-url-parse-rs/compare/v0.3.0...v0.3.1)
 - Loosen dependency restrictions in `Cargo.toml` ([#12](https://github.com/tjtelan/git-url-parse-rs/issues/12))
 - Update `strum` + `strum_macros` ([#14](https://github.com/tjtelan/git-url-parse-rs/issues/14))
 
-# [0.3.0](https://github.com/tjtelan/git-url-parse-rs/compare/v0.2.0...v0.3.0)
+# [0.3.0](https://github.com/tjtelan/git-url-parse-rs/compare/v0.2.0...v0.3.0) (2020-10-02)
 - Add `CHANGELOG.md`
 - Add new schemes `Ftp` and `Ftps`
 - Update `GitUrl` format for `Scheme::File` for `GitUrl.host` and `GitUrl.path`
 - Add more tests
 
-# [0.2.0](https://github.com/tjtelan/git-url-parse-rs/compare/v0.1.1...v0.2.0)
+# [0.2.0](https://github.com/tjtelan/git-url-parse-rs/compare/v0.1.1...v0.2.0) (2020-05-13)
 - Updating `GitUrl` format 
 - Add `trim_auth()`
 - Add `impl Display` for `GitUrl`
 - Rename enum `Protocol` to `Scheme`
 
-# [0.1.1](https://github.com/tjtelan/git-url-parse-rs/compare/v0.1.0...v0.1.1)
+# [0.1.1](https://github.com/tjtelan/git-url-parse-rs/compare/v0.1.0...v0.1.1) (2020-05-09)
 - Add CI via Github Actions
 - Add badges for docs, crates, build to `README`
 - Update `README.md`
 - Making enums and Structs `Clone`
 
-# [0.1.0](https://github.com/tjtelan/git-url-parse-rs/compare/v0.0.1...v0.1.0)
+# [0.1.0](https://github.com/tjtelan/git-url-parse-rs/compare/v0.0.1...v0.1.0) (2020-02-05)
 - Add support for Azure DevOps
 - Add `README.md`
 
-# [0.0.1](https://github.com/tjtelan/git-url-parse-rs/commit/9255fc3f0516e6cfa60c651dd0436fa702b701b1)
+# [0.0.1](https://github.com/tjtelan/git-url-parse-rs/commit/9255fc3f0516e6cfa60c651dd0436fa702b701b1) (2020-01-21)
 - Pre-process urls before feeding to `url` crate
 - Specialized normalization rules between ssh or file path urls
diff --git a/Cargo.toml b/Cargo.toml
@@ -3,24 +3,21 @@ authors = ["T.J. Telan <t.telan@gmail.com>"]
 categories = ["parser-implementations", "encoding"]
 description = "A parser for git repo urls based on url crate"
 documentation = "https://docs.rs/git-url-parse"
-edition = "2018"
+edition = "2021"
 keywords = ["git", "url", "parsing"]
 license = "MIT"
 name = "git-url-parse"
 readme = "README.md"
 repository = "https://github.com/tjtelan/git-url-parse-rs"
-version = "0.3.1"
-
-[badges.maintenance]
-status = "actively-developed"
+version = "0.4.0"
 
 [dependencies]
 log = "^0.4"
 url = "^2.2"
-strum = "^0.20"
-strum_macros = "^0.20"
-anyhow = "^1.0"
+strum = "^0.22"
+strum_macros = "^0.22"
+color-eyre = "^0.5"
 regex = "^1.4"
 
 [dev-dependencies]
-env_logger = "^0.8"
+env_logger = "^0.9"
diff --git a/README.md b/README.md
@@ -1,9 +1,11 @@
 # git-url-parse
 
 [![Crates.io](https://img.shields.io/crates/v/git-url-parse)](https://crates.io/crates/git-url-parse)
+![Crates.io](https://img.shields.io/crates/d/git-url-parse)
+[![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)
 [![docs.rs](https://docs.rs/git-url-parse/badge.svg)](https://docs.rs/git-url-parse/)
 [![licence](https://img.shields.io/github/license/tjtelan/git-url-parse-rs)](LICENSE)
-![Github actions build status](https://github.com/tjtelan/git-url-parse-rs/workflows/git-url-parse/badge.svg)
+![Maintenance](https://img.shields.io/maintenance/yes/2021)
 
 Supports common protocols as specified by the [Pro Git book](https://git-scm.com/book/en/v2)
 
diff --git a/bors.toml b/bors.toml
@@ -0,0 +1,6 @@
+status = [
+    "Done",
+]
+use_squash_merge = true
+delete_merged_branches = true
+timeout_sec = 900 # 15 mins
diff --git a/examples/multi.rs b/examples/multi.rs
@@ -1,4 +1,4 @@
-use anyhow::Result;
+use color_eyre::Result;
 use git_url_parse::GitUrl;
 
 fn main() -> Result<()> {
diff --git a/examples/trim_auth.rs b/examples/trim_auth.rs
@@ -1,4 +1,4 @@
-use anyhow::Result;
+use color_eyre::Result;
 use git_url_parse::GitUrl;
 
 fn main() -> Result<()> {
diff --git a/src/lib.rs b/src/lib.rs
diff --git a/tests/normalize.rs b/tests/normalize.rs

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-use anyhow::Result;`
	`1`	`+use color_eyre::Result;`
`2`	`2`	`use git_url_parse::GitUrl;`
`3`	`3`
`4`	`4`	`fn main() -> Result<()> {`