Impr: Add cargo dist and release

.github/workflows/release.yml

@@ -0,0 +1,137 @@
+# CI that:
+#
+# * checks for a Git Tag that looks like a release
+# * creates a Github Release™ and fills in its text
+# * builds artifacts with cargo-dist (executable-zips, installers)
+# * uploads those artifacts to the Github Release™
+#
+# Note that the Github Release™ will be created before the artifacts,
+# so there will be a few minutes where the release has no artifacts
+# and then they will slowly trickle in, possibly failing. To make
+# this more pleasant we mark the release as a "draft" until all
+# artifacts have been successfully uploaded. This allows you to
+# choose what to do with partial successes and avoids spamming
+# anyone with notifications before the release is actually ready.
+name: Release
+
+permissions:
+  contents: write
+
+# This task will run whenever you push a git tag that looks like a version
+# like "v1", "v1.2.0", "v0.1.0-prerelease01", "my-app-v1.0.0", etc.
+# The version will be roughly parsed as ({PACKAGE_NAME}-)?v{VERSION}, where
+# PACKAGE_NAME must be the name of a Cargo package in your workspace, and VERSION
+# must be a Cargo-style SemVer Version.
+#
+# If PACKAGE_NAME is specified, then we will create a Github Release™ for that
+# package (erroring out if it doesn't have the given version or isn't cargo-dist-able).
+#
+# If PACKAGE_NAME isn't specified, then we will create a Github Release™ for all
+# (cargo-dist-able) packages in the workspace with that version (this is mode is
+# intended for workspaces with only one dist-able package, or with all dist-able
+# packages versioned/released in lockstep).
+#
+# If you push multiple tags at once, separate instances of this workflow will
+# spin up, creating an independent Github Release™ for each one.
+#
+# If there's a prerelease-style suffix to the version then the Github Release™
+# will be marked as a prerelease.
+on:
+  push:
+    tags:
+      - '*-?v[0-9]+*'
+
+jobs:
+  # Create the Github Release™ so the packages have something to be uploaded to
+  create-release:
+    runs-on: ubuntu-latest
+    outputs:
+      has-releases: ${{ steps.create-release.outputs.has-releases }}
+    env:
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Rust
+        run: rustup update 1.67.1 --no-self-update && rustup default 1.67.1
+      - name: Install cargo-dist
+        run: curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.0.7/cargo-dist-installer.sh | sh
+      - id: create-release
+        run: |
+          cargo dist plan --tag=${{ github.ref_name }} --output-format=json > dist-manifest.json
+          echo "dist plan ran successfully"
+          cat dist-manifest.json
+
+          # Create the Github Release™ based on what cargo-dist thinks it should be
+          ANNOUNCEMENT_TITLE=$(jq --raw-output ".announcement_title" dist-manifest.json)
+          IS_PRERELEASE=$(jq --raw-output ".announcement_is_prerelease" dist-manifest.json)
+          jq --raw-output ".announcement_github_body" dist-manifest.json > new_dist_announcement.md
+          gh release create ${{ github.ref_name }} --draft --prerelease="$IS_PRERELEASE" --title="$ANNOUNCEMENT_TITLE" --notes-file=new_dist_announcement.md
+          echo "created announcement!"
+
+          # Upload the manifest to the Github Release™
+          gh release upload ${{ github.ref_name }} dist-manifest.json
+          echo "uploaded manifest!"
+
+          # Disable all the upload-artifacts tasks if we have no actual releases
+          HAS_RELEASES=$(jq --raw-output ".releases != null" dist-manifest.json)
+          echo "has-releases=$HAS_RELEASES" >> "$GITHUB_OUTPUT"
+
+  # Build and packages all the things
+  upload-artifacts:
+    # Let the initial task tell us to not run (currently very blunt)
+    needs: create-release
+    if: ${{ needs.create-release.outputs.has-releases == 'true' }}
+    strategy:
+      matrix:
+        # For these target platforms
+        include:
+        - os: macos-11
+          dist-args: --artifacts=local --target=aarch64-apple-darwin --target=x86_64-apple-darwin
+          install-dist: curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.0.7/cargo-dist-installer.sh | sh
+        - os: ubuntu-20.04
+          dist-args: --artifacts=local --target=x86_64-unknown-linux-gnu
+          install-dist: curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.0.7/cargo-dist-installer.sh | sh
+        - os: windows-2019
+          dist-args: --artifacts=local --target=x86_64-pc-windows-msvc
+          install-dist: irm  https://github.com/axodotdev/cargo-dist/releases/download/v0.0.7/cargo-dist-installer.ps1 | iex
+
+    runs-on: ${{ matrix.os }}
+    env:
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Rust
+        run: rustup update 1.67.1 --no-self-update && rustup default 1.67.1
+      - name: Install cargo-dist
+        run: ${{ matrix.install-dist }}
+      - name: Run cargo-dist
+        # This logic is a bit janky because it's trying to be a polyglot between
+        # powershell and bash since this will run on windows, macos, and linux!
+        # The two platforms don't agree on how to talk about env vars but they
+        # do agree on 'cat' and '$()' so we use that to marshal values between commands.
+        run: |
+          # Actually do builds and make zips and whatnot
+          cargo dist build --tag=${{ github.ref_name }} --output-format=json ${{ matrix.dist-args }} > dist-manifest.json
+          echo "dist ran successfully"
+          cat dist-manifest.json
+
+          # Parse out what we just built and upload it to the Github Release™
+          jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json > uploads.txt
+          echo "uploading..."
+          cat uploads.txt
+          gh release upload ${{ github.ref_name }} $(cat uploads.txt)
+          echo "uploaded!"
+
+  # Mark the Github Release™ as a non-draft now that everything has succeeded!
+  publish-release:
+    # Only run after all the other tasks, but it's ok if upload-artifacts was skipped
+    needs: [create-release, upload-artifacts]
+    if: ${{ always() && needs.create-release.result == 'success' && (needs.upload-artifacts.result == 'skipped' || needs.upload-artifacts.result == 'success') }}
+    runs-on: ubuntu-latest
+    env:
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: mark release as non-draft
+        run: |
+          gh release edit ${{ github.ref_name }} --draft=false

Cargo.toml

@@ -13,6 +13,25 @@ repository = "https://github.com/coastalwhite/wavedrom-rs"
 homepage = "https://github.com/coastalwhite/wavedrom-rs"
 edition = "2021"
 license = "MIT OR Apache-2.0"
+description = "A Pure Rust Digital Timing Diagram Generator based on WaveDrom-JS"
 
 [workspace.dependencies]
-clap = "4.3.2"
+clap = "4.3.2"
+
+# Config for 'cargo dist'
+[workspace.metadata.dist]
+# The preferred cargo-dist version to use in CI (Cargo.toml SemVer syntax)
+cargo-dist-version = "0.0.7"
+# The preferred Rust toolchain to use in CI (rustup toolchain syntax)
+rust-toolchain-version = "1.67.1"
+# CI backends to support (see 'cargo dist generate-ci')
+ci = ["github"]
+# The installers to generate for each app
+installers = []
+# Target platforms to build apps for (Rust target-triple syntax)
+targets = ["x86_64-unknown-linux-gnu", "x86_64-apple-darwin", "x86_64-pc-windows-msvc", "aarch64-apple-darwin"]
+
+# The profile that 'cargo dist' will build with
+[profile.dist]
+inherits = "release"
+lto = "thin"

dev-doc/releasing.md

@@ -0,0 +1,38 @@
+# Releasing
+
+## Tools
+
+```bash
+cargo install cargo-dist
+cargo install cargo-release
+cargo install cargo-hack
+cargo install cargo-deny
+```
+
+## Formatting
+
+## Running Tests
+
+```bash
+cd wavedrom-core
+cargo hack --feature-powerset check
+cargo hack --feature-powerset test
+cargo hack --feature-powerset doc
+```
+
+## Linting
+
+```bash
+cd wavedrom-core
+cargo deny check
+cargo clippy
+```
+
+## Pushing a new release
+
+Releasing is done with [cargo-dist](https://github.com/axodotdev/cargo-dist) and
+[cargo-release](https://github.com/crate-ci/cargo-release).
+
+```rust
+cargo release X.Y.Z
+```

mdbook-wavedrom/Cargo.toml

@@ -1,12 +1,16 @@
 [package]
-name = "mdbook-wavedrom"
+name = "mdbook-wavedrom-rs"
 version.workspace = true
 authors.workspace = true
 repository.workspace = true
 homepage.workspace = true
 edition.workspace = true
 license = "MPL-2.0"
 
+keywords = ["diagram", "svg", "signal", "digital", "timing"]
+categories = ["graphics", "visualization", "wasm"]
+description = "A MdBook preprocessor for WaveDrom Digital Timing Diagrams"
+
 [dependencies]
 anyhow = "1.0.71"
 pulldown-cmark = "0.9.3"
@@ -23,3 +27,4 @@ default-features = false
 
 [dependencies.wavedrom]
 path = "../wavedrom-core"
+version = "0.1.0"

mdbook-wavedrom/README.md

@@ -7,7 +7,7 @@ Integration for [wavedrom-rs] with [mdbook].
 First, install the preprocessor utilizing the [Rust Toolchain].
 
 ```bash
-cargo install mdbook-wavedrom
+cargo install mdbook-wavedrom-rs
 ```
 
 Then, add the preprocessor to the list of preprocessors in your [mdbook]

mdbook-wavedrom/src/main.rs

@@ -69,7 +69,7 @@ fn handle_supports(pre: &dyn Preprocessor, sub_args: &ArgMatches) -> ! {
 
 mod nop_lib {
     use mdbook::BookItem;
-    use mdbook_wavedrom::insert_wavedrom;
+    use mdbook_wavedrom_rs::insert_wavedrom;
     use wavedrom::options::RenderOptions;
     use wavedrom::skin::Skin;
     use wavedrom::PathAssembleOptions;

release.toml

@@ -0,0 +1 @@
+allow-branch = ["main"]

wavedrom-cli/Cargo.toml

@@ -6,6 +6,7 @@ repository.workspace = true
 homepage.workspace = true
 edition.workspace = true
 license.workspace = true
+description.workspace = true
 
 [[bin]]
 name = "wavedrom"
@@ -16,3 +17,4 @@ workspace = true
 
 [dependencies.wavedrom]
 path = "../wavedrom-core"
+version = "0.1.0"

wavedrom-core/Cargo.toml

@@ -6,7 +6,12 @@ repository.workspace = true
 homepage.workspace = true
 edition.workspace = true
 license.workspace = true
-include = ["/src", "/helvetica.ttf"]
+description.workspace = true
+
+keywords = ["diagram", "svg", "signal", "digital", "timing"]
+categories = ["graphics", "visualization", "wasm"]
+
+include = ["/src", "/helvetica.ttf", "/assets", "/README.md"]
 
 [dependencies.json5]
 version = "0.4.1"

wavedrom-wasm/Cargo.toml

@@ -7,6 +7,10 @@ homepage.workspace = true
 edition.workspace = true
 license.workspace = true
 
+description = "A WASM interface for WaveDrom Digital Timing Diagrams"
+
+publish = false
+
 [lib]
 crate-type = ["cdylib"]