Cleanup (#64)

* Fixup README * Fixup CHANGELOG, add release.toml * Update dependencies * Fix puffin README * Really fix README * Oops * Fixup manifests * Cleanup CI * Cleanup changelogs, setup release scripts * Fix build * Add PR to CHANGELOGs * Fix lints
EmbarkStudios · Feb 7, 2022 · 491e85b · 491e85b
1 parent 0770a06
commit 491e85b
Show file tree

Hide file tree

Showing 22 changed files with 1,275 additions and 513 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -11,7 +11,7 @@ name: CI
 jobs:
   lint:
     name: Lint
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
@@ -29,72 +29,40 @@ jobs:
       # make sure all code has been formatted with rustfmt
       - run: rustup component add rustfmt
       - name: rustfmt
-        uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: -- --check --color always
+        run: cargo fmt -- --check --color always
 
       - run: rustup component add clippy
       - run: rustup target add wasm32-unknown-unknown
-      - name: cargo fetch
-        uses: actions-rs/cargo@v1
-        with:
-          command: fetch
+      - run: cargo fetch
       - name: cargo clippy
-        uses: actions-rs/cargo@v1
-        with:
-          command: clippy
-          args: --lib --tests -- -D warnings
-      - name: cargo check
-        uses: actions-rs/cargo@v1
-        with:
-          command: check
-          args: --all-targets
-      - name: cargo check wasm32
-        uses: actions-rs/cargo@v1
-        with:
-          command: check
-          args: -p puffin_viewer --lib --target wasm32-unknown-unknown --all-features
+        run: cargo clippy --all-targets -- -D warnings
+      - name: cargo clippy wasm32
+        run: cargo clippy -p puffin_viewer --all-targets --target wasm32-unknown-unknown --all-features
 
   test:
     name: Test
     strategy:
       matrix:
-        os: [ubuntu-latest, windows-latest, macOS-latest]
+        os: [ubuntu-20.04, windows-latest, macOS-latest]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
         with:
           toolchain: stable
           override: true
-      - name: cargo fetch
-        uses: actions-rs/cargo@v1
-        with:
-          command: fetch
+      - run: cargo fetch
       - name: Install packages (Linux)
         if: runner.os == 'Linux'
         run: |
           sudo apt-get update
           sudo apt-get -yq --no-install-suggests --no-install-recommends install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libasound2-dev libxkbcommon-dev # egui_glium dependencies
           sudo apt-get install libgtk-3-dev # rfd dependencies
       - name: cargo test build
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --tests --release
+        run: cargo build --tests --release --all-features
       - name: cargo test
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: -p puffin -p puffin_egui -p puffin_http -p puffin-imgui -p --all-features
+        run: cargo test -p puffin -p puffin_egui -p puffin_http -p puffin-imgui --release --all-features
       - name: cargo test --doc
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --workspace --doc
+        run: cargo test --workspace --doc
       - name: cargo doc
-        uses: actions-rs/cargo@v1
-        with:
-          command: doc
-          args: -p puffin -p puffin_egui -p puffin_http -p puffin-imgui -p --lib --no-deps --all-features
+        run: cargo doc -p puffin -p puffin_egui -p puffin_http -p puffin-imgui -p --lib --no-deps --all-features
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,68 +1,94 @@
+<!-- markdownlint-disable blanks-around-headings blanks-around-lists no-duplicate-heading -->
 # Changelog
 
 All notable changes to `puffin` will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-
-## Unreleased
+<!-- next-header -->
+## [Unreleased] - ReleaseDate
+### Fixed
 * Fix compilation for `wasm32-unknown-unknown`.
+
+### Changed
 * Upgrade `ztd` v0.9 -> v0.10
+* [PR#64](https://github.com/EmbarkStudios/puffin/pull/64) updated dependencies and cleaned up crate metadata.
 
-## 0.12.1 - 2021-11-16
+## [0.12.1] - 2021-11-16
+### Fixed
 * Make `parking_lot` an optional dependency.
 
-
-## 0.12.0 - 2021-11-16
+## [0.12.0] - 2021-11-16
+### Fixed
 * In-memory compression of frames to use up less RAM. Enabled by the new feature "packing".
-* Remove support for legacy `.puffin` files in order to remove `lz4_flex` dependency.
 
+### Changed
+* Remove support for legacy `.puffin` files in order to remove `lz4_flex` dependency.
 
-## 0.11.0 - 2021-11-12
+## [0.11.0] - 2021-11-12
+### Changed
 * Introduce `StreamInfoRef` to avoid memory allocations.
 * Remove deprecated macros `profile_function_data` and `profile_scope_data`.
 
-
-## 0.10.1 - 2021-11-02
+## [0.10.1] - 2021-11-02
+### Fixed
 * `now_ns` now returns nanoseconds since unix epoch.
 * Make scope merging deterministic.
 
-
-## 0.10.0 - 2021-10-12
+## [0.10.0] - 2021-10-12
+### Changed
 * Rewrite scope merging.
 * Implement `Hash` on `ThreadInfo`.
 
-
-## 0.9.0 - 2021-09-20
+## [0.9.0] - 2021-09-20
+### Changed
 * API change: split out new `FrameView` and `GlobalFrameView` from `GlobalProfiler`.
 
-
-## 0.8.1 - 2021-09-07
+## [0.8.1] - 2021-09-07
+### Fixed
 * Remove profile scopes in serialization to avoid deadlock in `puffin_viewer`.
 
-
-## 0.8.0 - 2021-09-06
+## [0.8.0] - 2021-09-06
+### Changed
 * Switch from lz4 to zstd compression for 50% file size and bandwidth reduction.
 
-
-## 0.7.0 - 2021-08-23
+## [0.7.0] - 2021-08-23
+### Changed
 * Speed up `GlobalProfiler::new_frame`.
 * New `serialization` feature flag enables exporting and importing `.puffin` files. This replaces the old `with_serde` feature flag.
-* Add `GlobalProfiler::add_sink` for installing callbacks that are called each frame.
 
+### Added
+* Add `GlobalProfiler::add_sink` for installing callbacks that are called each frame.
 
-## 0.6.0 - 2021-07-05
+## [0.6.0] - 2021-07-05
+### Fixed
 * Handle Windows, which uses backslash (`\`) as path separator.
 
-
-## 0.5.2
+## [0.5.2] - 2021-14-27
+### Changed
 * Add opt-in `serde` support.
 
-
-## 0.5.1
+## [0.5.1] - 2021-05-27
+### Fixed
 * Remove stderr warning about empty frames.
 
-
-## 0.5.0
+## [0.5.0] - 2021-05-27
+### Changed
 * `GlobalProfiler` now store recent history and the slowest frames.
+
+<!-- next-url -->
+[Unreleased]: https://github.com/EmbarkStudios/puffin/compare/0.12.1...HEAD
+[0.12.1]: https://github.com/EmbarkStudios/puffin/compare/0.12.0...0.12.1
+[0.12.0]: https://github.com/EmbarkStudios/puffin/compare/0.11.0...0.12.0
+[0.11.0]: https://github.com/EmbarkStudios/puffin/compare/0.10.1...0.11.0
+[0.10.1]: https://github.com/EmbarkStudios/puffin/compare/0.10.0...0.10.1
+[0.10.0]: https://github.com/EmbarkStudios/puffin/compare/0.9.0...0.10.0
+[0.9.0]: https://github.com/EmbarkStudios/puffin/compare/0.8.1...0.9.0
+[0.8.1]: https://github.com/EmbarkStudios/puffin/compare/0.8.0...0.8.1
+[0.8.0]: https://github.com/EmbarkStudios/puffin/compare/0.7.0...0.8.0
+[0.7.0]: https://github.com/EmbarkStudios/puffin/compare/0.6.0...0.7.0
+[0.6.0]: https://github.com/EmbarkStudios/puffin/compare/0.5.1...0.6.0
+[0.5.2]: https://github.com/EmbarkStudios/puffin/compare/0.5.1...0.5.2
+[0.5.1]: https://github.com/EmbarkStudios/puffin/compare/0.5.0...0.5.1
+[0.5.0]: https://github.com/EmbarkStudios/puffin/releases/tag/0.5.0