From 4ed94fce7c38b903cab108896cddd32316016ae2 Mon Sep 17 00:00:00 2001 From: Jordan Kaye Date: Sun, 2 Feb 2025 07:09:57 -0700 Subject: [PATCH 1/3] Updates metadata A number of metadata updates are required for a proper release: * readme.md -> README.md for crates.io * shield branch update for PR verification badge * documentation and repository for Cargo.toml * action cancellation for PR verification --- .github/workflows/verify.yml | 3 +++ Cargo.toml | 2 ++ readme.md => README.md | 2 +- 3 files changed, 6 insertions(+), 1 deletion(-) rename readme.md => README.md (94%) diff --git a/.github/workflows/verify.yml b/.github/workflows/verify.yml index e54acb7..f871012 100644 --- a/.github/workflows/verify.yml +++ b/.github/workflows/verify.yml @@ -1,6 +1,9 @@ name: "Verify" on: pull_request: +concurrency: + group: ${{ github.workflow }}-${{ github.event.pull_request.number }} + cancel-in-progress: true jobs: verify: runs-on: ubuntu-latest diff --git a/Cargo.toml b/Cargo.toml index 4cf3b68..86efb3a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,6 +3,8 @@ name = "refined" version = "0.0.1" edition = "2021" description = "Simple refinement types; parse, don't validate!" +documentation = "https://docs.rs/refined" +repository = "https://github.com/jkaye2012/refined" license = "MIT OR Apache-2.0" [dependencies] diff --git a/readme.md b/README.md similarity index 94% rename from readme.md rename to README.md index bf8068a..13966d2 100644 --- a/readme.md +++ b/README.md @@ -1,7 +1,7 @@ # Refined ![Crates.io Version](https://img.shields.io/crates/v/refined) -![Release Status](https://img.shields.io/github/actions/workflow/status/jkaye2012/refined/publish.yml?branch=main) +![Release Status](https://img.shields.io/github/actions/workflow/status/jkaye2012/refined/publish.yml) ![Crates.io License](https://img.shields.io/crates/l/refined) Simple [refinement types](https://en.wikipedia.org/wiki/Refinement_type) for Rust. From d82738d93d4b6b7879460e7572b6ff82d45ac1f2 Mon Sep 17 00:00:00 2001 From: Jordan Kaye Date: Sun, 2 Feb 2025 07:12:59 -0700 Subject: [PATCH 2/3] Updates changelog --- CHANGELOG.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index ab21213..84bd859 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.0.2] - 2025-02-02 + +There are no functional changes in this release. The version was bumped to update crates.io +metadata and documentation for a proper release. + ## [0.0.1] - 2025-02-02 ### Added From 8a331074865f5842fff7fd58ce61cb58b1dc1b9a Mon Sep 17 00:00:00 2001 From: Jordan Kaye Date: Sun, 2 Feb 2025 07:16:15 -0700 Subject: [PATCH 3/3] Updates broken README links --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 13966d2..eb30ab6 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,13 @@ Simple [refinement types](https://en.wikipedia.org/wiki/Refinement_type) for Rust. -For detailed information, please see the [documentation on docs.rs](https://docs.rs/crate/refined/latest). +For detailed information, please see the [documentation on docs.rs](https://docs.rs/refined/latest/refined). ## Quickstart -The [basic usage example on docs.rs](file:///home/jkaye/git/refined/target/doc/refined/index.html#basic-usage) +The [basic usage example on docs.rs](https://docs.rs/refined/latest/refined/#basic-usage) is a minimal example that should be easy to follow. -You can also use the [examples](https://github.com/jkaye2012/refined/examples) to get started. Each example is +You can also use the [examples](https://github.com/jkaye2012/refined/tree/main/examples) to get started. Each example is a complete cargo project of its own. They are meant to be run with `cargo run` so that you can view their output and reference it against the code.