Merge pull request #11 from sebastienrousseau/feat/serde_yml

v0.0.12
sebastienrousseau · Aug 25, 2024 · 62efd66 · 62efd66
2 parents 9475310 + f0d0655
commit 62efd66
Show file tree

Hide file tree

Showing 55 changed files with 2,021 additions and 2,916 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -1,5 +1,4 @@
-# Copyright © 2023 serde_yml. All rights reserved.
-# SPDX-License-Identifier: Apache-2.0 OR MIT
+# SPDX-License-Identifier: MIT
 
 # EditorConfig helps developers define and maintain consistent
 # coding styles between different editors and IDEs

diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,9 @@
+# Auto detect text files and perform normalization
+*          text=auto eol=lf
+
+*.rs       text diff=rust eol=lf
+*.toml     text diff=toml eol=lf
+Cargo.lock text eol=lf
+
+*.sh       text eol=lf
+*.ps1      text eol=crlf
diff --git a/.github/workflows/audit.yml b/.github/workflows/audit.yml
@@ -16,11 +16,11 @@ jobs:
     name: Audit dependencies
     runs-on: ubuntu-latest
     steps:
-      - uses: hecrj/setup-rust-action@v2
+      - uses: hecrj/setup-rust-action@v2.0.1
       - name: Install cargo-audit
         run: cargo install cargo-audit
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v4.1.7
       - name: Resolve dependencies
         run: cargo update
 

diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
@@ -16,9 +16,9 @@ jobs:
     name: Check
     runs-on: ubuntu-latest
     steps:
-      - uses: hecrj/setup-rust-action@v2
+      - uses: hecrj/setup-rust-action@v2.0.1
         with:
           components: clippy
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v4.1.7
       - name: Check lints
         run: cargo check --all-targets --workspace --all-features
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -21,19 +21,19 @@ jobs:
     steps:
       # Checkout the repository
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v4.1.7
 
       # Setup Rust nightly
       - name: Install Rust
-        uses: actions-rs/toolchain@v1
+        uses: actions-rs/toolchain@v1.0.6
         id: toolchain
         with:
           toolchain: nightly
           override: true
 
       # Configure cache for Cargo
       - name: Cache Cargo registry, index
-        uses: actions/cache@v4
+        uses: actions/cache@v4.0.2
         id: cache-cargo
         with:
           path: |
@@ -44,7 +44,7 @@ jobs:
 
       # Run tests with all features
       - name: Test (cargo test)
-        uses: actions-rs/cargo@v1
+        uses: actions-rs/cargo@v1.0.1
         with:
           command: test
           args: "--workspace"
@@ -55,7 +55,7 @@ jobs:
 
       # Upload to Codecov.io
       - name: Upload to Codecov.io
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v4.5.0
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           file: ${{ steps.coverage.outputs.report }}
diff --git a/.github/workflows/document.yml b/.github/workflows/document.yml
@@ -14,16 +14,16 @@ on:
 jobs:
   all:
     name: Document
-    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+    if: github.ref == 'refs/heads/master' && github.event_name == 'push'
     runs-on: ubuntu-latest
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
     steps:
-      - uses: hecrj/setup-rust-action@v2
+      - uses: hecrj/setup-rust-action@v2.0.1
         with:
           rust-version: nightly
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v4.1.7
 
       - name: Update libssl
         run: |
@@ -38,7 +38,7 @@ jobs:
             echo '<html><head><meta http-equiv="refresh" content="0; url=/serde_yml/"></head><body></body></html>' > ./target/doc/index.html
 
       - name: Deploy
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v4.3.6
         with:
           name: documentation
           path: target/doc
@@ -49,7 +49,7 @@ jobs:
         run: echo 'doc.serdeyml.com' > ./target/doc/CNAME
 
       - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v4
+        uses: peaceiris/actions-gh-pages@v4.0.0
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./target/doc

diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml
@@ -16,9 +16,9 @@ jobs:
     name: Format
     runs-on: ubuntu-latest
     steps:
-      - uses: hecrj/setup-rust-action@v2
+      - uses: hecrj/setup-rust-action@v2.0.1
         with:
           components: clippy
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v4.1.7
       - name: Check format
         run: cargo fmt --all -- --check --verbose
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -16,9 +16,9 @@ jobs:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: hecrj/setup-rust-action@v2
+      - uses: hecrj/setup-rust-action@v2.0.1
         with:
           components: clippy
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v4.1.7
       - name: Check lints
         run: cargo clippy --workspace --all-features --all-targets --no-deps -- -D warnings
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -54,20 +54,20 @@ jobs:
       # Check out the repository code.
       - name: Checkout sources
         id: checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v4.1.7
 
       # Install the stable Rust toolchain.
       - name: Install stable toolchain
         id: install-toolchain
-        uses: actions-rs/toolchain@v1
+        uses: actions-rs/toolchain@v1.0.6
         with:
           toolchain: stable
           override: true
 
       # Cache dependencies to speed up subsequent builds.
       - name: Cache dependencies
         id: cache-dependencies
-        uses: actions/cache@v4
+        uses: actions/cache@v4.0.2
         with:
           path: ~/.cargo
           key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
@@ -81,7 +81,7 @@ jobs:
       # Build the targets
       - name: Build targets
         id: build-targets
-        uses: actions-rs/cargo@v1
+        uses: actions-rs/cargo@v1.0.1
         with:
           command: build
           args: --verbose --workspace --release --target ${{ env.TARGET }}
@@ -97,7 +97,7 @@ jobs:
       # Upload the binary for each target
       - name: Upload the binary
         id: upload-binary
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v4.3.6
         with:
           name: ${{ env.TARGET }}.tar.gz
           path: target/package/${{ env.TARGET }}.tar.gz
@@ -111,11 +111,11 @@ jobs:
     steps:
       # Check out the repository code
       - name: Checkout sources
-        uses: actions/checkout@v4
+        uses: actions/checkout@v4.1.7
 
       # Install the stable Rust toolchain
       - name: Install stable toolchain
-        uses: actions-rs/toolchain@v1
+        uses: actions-rs/toolchain@v1.0.6
         with:
           toolchain: stable
           override: true
@@ -129,7 +129,7 @@ jobs:
 
       # Cache dependencies to speed up subsequent builds
       - name: Cache dependencies
-        uses: actions/cache@v4
+        uses: actions/cache@v4.0.2
         with:
           path: ~/.cargo
           key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
@@ -186,7 +186,7 @@ jobs:
       # Create the release on GitHub releases
       - name: Create Release
         id: create-release
-        uses: actions/create-release@v1
+        uses: actions/create-release@v1.1.4
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VERSION: ${{ env.VERSION }}
@@ -207,20 +207,20 @@ jobs:
     steps:
       # Check out the repository code
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v4.1.7
 
       # Install the stable Rust toolchain
       - name: Install stable toolchain
         id: install-toolchain
-        uses: actions-rs/toolchain@v1
+        uses: actions-rs/toolchain@v1.0.6
         with:
           toolchain: stable
           override: true
 
       # Cache dependencies to speed up subsequent builds
       - name: Cache dependencies
         id: cache-dependencies
-        uses: actions/cache@v4
+        uses: actions/cache@v4.0.2
         with:
           path: /home/runner/.cargo/registry/index/
           key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }}
@@ -242,7 +242,7 @@ jobs:
       # Publish the Rust library to Crate.io
       - name: Publish Library to Crate.io
         id: publish-library
-        uses: actions-rs/cargo@v1
+        uses: actions-rs/cargo@v1.0.1
         env:
           CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_API_TOKEN }}
         with:

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -14,7 +14,7 @@ jobs:
     steps:
       # Checkout the repository
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v4.1.7
 
       # Setup Rust
       - name: Setup Rust
@@ -24,7 +24,7 @@ jobs:
 
       # Configure cache
       - name: Configure cache
-        uses: actions/cache@v4
+        uses: actions/cache@v4.0.2
         with:
           path: |
             ~/.cargo/bin/

diff --git a/.gitignore b/.gitignore
@@ -1,9 +1,12 @@
 *.DS_Store
-*.profraw
 *.log
+*.profraw
+/.idea/
+/.idea/
 /.vscode/
+/build.rs
+/rust-toolchain
 /target/
 build
 Cargo.lock
 Icon?
-public/test_site/test.txt
diff --git a/Cargo.toml b/Cargo.toml
@@ -13,8 +13,8 @@ license = "MIT OR Apache-2.0"
 name = "serde_yml"
 readme = "README.md"
 repository = "https://github.com/sebastienrousseau/serde_yml"
-rust-version = "1.60"
-version = "0.0.11"
+rust-version = "1.56.0"
+version = "0.0.12"
 include = [
     "/CONTRIBUTING.md",
     "/LICENSE-APACHE",
@@ -38,19 +38,20 @@ include = [
 
 
 [dependencies]
-indexmap = "2.2.6"
-itoa = "1.0.11"
-libyml = "0.0.4"
-log = { version = "0.4.22", features = ["std"] }
-memchr = "2.7.4"
-ryu = "1.0.18"
-serde = { version = "1.0.204", features = ["derive"] }
-serde_json = "1.0.120"
-tempfile = "3.10.1"
+indexmap = "2.2.4"
+itoa = "1.0"
+libyml = "0.0.5"
+memchr = { version = "2", default-features = false }
+ryu = "1.0"
+serde = { version = "1.0.204" }
+
+[build-dependencies]
+# Dependencies for build scripts.
+version_check = "0.9.4" # Check the Rust version used to compile the package.
 
 [dev-dependencies]
-anyhow = "1.0.86"
 indoc = "2.0.5"
+serde = { version = "1.0.204", features = ["derive"] }
 serde_derive = "1.0.204"
 
 [features]
@@ -64,8 +65,17 @@ path = "src/lib.rs"
 required-features = []
 
 [package.metadata.docs.rs]
+# Specify arguments for rustdoc to enhance documentation quality.
+rustdoc-args = [
+    "--generate-link-to-definition",
+    "--cfg", "docsrs",
+    "--document-private-items",
+    "--display-warnings"
+]
+# Build docs with all crate features enabled to cover the entire API.
+all-features = true
+# Target platform for the docs, ensuring compatibility with common Linux servers.
 targets = ["x86_64-unknown-linux-gnu"]
-rustdoc-args = ["--generate-link-to-definition"]
 
 # Linting config
 [lints.rust]
@@ -104,7 +114,6 @@ macro_use_extern_crate = "deny"
 meta_variable_misuse = "deny"
 missing_fragment_specifier = "deny"
 noop_method_call = "deny"
-pointer_structural_match = "deny"
 rust_2018_idioms = { level = "deny", priority = -1 }
 rust_2021_compatibility = { level = "deny", priority = -1 }
 single_use_lifetimes = "deny"