chore: merge release-v0.4.0 into main

mrjackwills · Nov 21, 2023 · 6bb06bc · 6bb06bc
2 parents 17ea8a1 + be8c4d0
commit 6bb06bc
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 39 deletions.
diff --git a/.github/release-body.md b/.github/release-body.md
@@ -1,10 +1,18 @@
-### 2023-11-20
+### 2023-11-21
 
-### (Quick) Fixes
-+ Bollard dependency fix, [1702414f922d87ff1cb6654128c09c0074870123]
+### Chores
++ workflow dependencies updated, [6a4cf6490d08b976734e2bc8186d94c095700558]
++ dependencies updated, [e301b51891e03ea40b2f904583119da3bc4daf53], [81d5b326db8881263f2c9072e1426948e41b4a0f], [294cc2684f42daab9d51601e235a384f55617678]
++ lints moved from main.rs to Cargo.toml, [2de76e2f358be9c1500ca3dc4f9df0979ed8ed28]
++ .devcontainer updated, [37d2ee915625806dd11c2cc816a892aae12a777c]
+
+### Features
++ Docker exec mode - you are now able to attempt to exec into a container by pressing the `e` key, closes #28, [c8077bca0b673478cfbb417e677a885136ba9eff], [0e5ee143b008c9d0ee0b681231a1568be227150b], [0e5ee143b008c9d0ee0b681231a1568be227150b]
++ Export logs feature, press `s` to save logs, use `--save-dir` cli-arg to customise output location, closes #1, [a15da5ed43d07852504a4dd1884a189e3f5b9d84]
+
+### Fixes
 + GitHub workflow, cargo publish before create release, [ae4ce3b549c40cc8bd713f375f030b185179a6e2]
++ sorted created_at clash, closes #22, [3a6489396e87702ce94b349a7f47028ece7922f6]
 + `as_ref()` fixed, thanks [Daniel-Boll](https://github.com/Daniel-Boll), [77fbaa8b1669286369b6ec1edd80220c808b628f]
 
-See [https://github.com/mrjackwills/oxker/releases/tag/v0.4.0](https://github.com/mrjackwills/oxker/releases/tag/v0.4.0) for more detailed v0.4.0 release notes
-
 see <a href='https://github.com/mrjackwills/oxker/blob/main/CHANGELOG.md'>CHANGELOG.md</a> for more details
diff --git a/.github/workflows/create_release_and_build.yml b/.github/workflows/create_release_and_build.yml
@@ -6,28 +6,11 @@ on:
 
 jobs:
 
-  #########################
-  ## Publish to crates.io #
-  #########################
-
-  cargo_publish:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: publish to crates.io
-        uses: katyo/publish-crates@v1
-        with:
-          registry-token: ${{ secrets.CRATES_IO_TOKEN }}
-
-
   #################################################
   ## Cross platform binary build for release page #
   #################################################
 
   cross_platform_build:
-   needs: [cargo_publish]
     strategy:
       matrix:
         platform:
@@ -105,14 +88,29 @@ jobs:
             **/oxker_*.zip
             **/oxker_*.tar.gz
 
+  ##################
+  ## Cargo publish #
+  ##################
+
+  cargo_publish:
+    needs: [create_release]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
 
+      - name: publish to crates.io
+        uses: katyo/publish-crates@v1
+        with:
+          registry-token: ${{ secrets.CRATES_IO_TOKEN }}
 
+
   #########################################
   ## Build images for Dockerhub & ghcr.io #
   #########################################
 
   image_build:
-    needs: [create_release]
+    needs: [cargo_publish]
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,15 +1,5 @@
-# <a href='https://github.com/mrjackwills/oxker/releases/tag/v0.4.1'>v0.4.1</a>
-### 2023-11-20
-
-### (Quick) Fixes
-+ Bollard dependency fix, [1702414f](https://github.com/mrjackwills/oxker/commit/1702414f922d87ff1cb6654128c09c0074870123)
-+ GitHub workflow, cargo publish before create release, [ae4ce3b5](https://github.com/mrjackwills/oxker/commit/ae4ce3b549c40cc8bd713f375f030b185179a6e2)
-+ `as_ref()` fixed, thanks [Daniel-Boll](https://github.com/Daniel-Boll), [77fbaa8b](https://github.com/mrjackwills/oxker/commit/77fbaa8b1669286369b6ec1edd80220c808b628f)
-
-See [https://github.com/mrjackwills/oxker/releases/tag/v0.4.0](https://github.com/mrjackwills/oxker/releases/tag/v0.4.0) for more detailed v0.4.0 release notes
-
 # <a href='https://github.com/mrjackwills/oxker/releases/tag/v0.4.0'>v0.4.0</a>
-### 2023-11-20
+### 2023-11-21
 
 ### Chores
 + workflow dependencies updated, [6a4cf649](https://github.com/mrjackwills/oxker/commit/6a4cf6490d08b976734e2bc8186d94c095700558)
@@ -22,7 +12,9 @@ See [https://github.com/mrjackwills/oxker/releases/tag/v0.4.0](https://github.co
 + Export logs feature, press `s` to save logs, use `--save-dir` cli-arg to customise output location, closes [#1](https://github.com/mrjackwills/oxker/issues/1), [a15da5ed](https://github.com/mrjackwills/oxker/commit/a15da5ed43d07852504a4dd1884a189e3f5b9d84)
 
 ### Fixes
++ GitHub workflow, cargo publish before create release, [ae4ce3b5](https://github.com/mrjackwills/oxker/commit/ae4ce3b549c40cc8bd713f375f030b185179a6e2)
 + sorted created_at clash, closes [#22](https://github.com/mrjackwills/oxker/issues/22), [3a648939](https://github.com/mrjackwills/oxker/commit/3a6489396e87702ce94b349a7f47028ece7922f6)
++ `as_ref()` fixed, thanks [Daniel-Boll](https://github.com/Daniel-Boll), [77fbaa8b](https://github.com/mrjackwills/oxker/commit/77fbaa8b1669286369b6ec1edd80220c808b628f)
 
 # <a href='https://github.com/mrjackwills/oxker/releases/tag/v0.3.3'>v0.3.3</a>
 ### 2023-10-21

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "oxker"
-version = "0.4.1"
+version = "0.4.0"
 edition = "2021"
 authors = ["Jack Wills <[email protected]>"]
 description = "A simple tui to view & control docker containers"

diff --git a/README.md b/README.md
@@ -117,8 +117,8 @@ Available command line arguments
 |```-t```| Remove timestamps from each log entry.|
 |```-s```| If running via Docker, will display the oxker container.|
 |```-g```| No TUI, essentially a debugging mode with limited functionality, for now.|
-|```--host [hostname]```| Connect to Docker with a custom hostname. Defaults to `/var/run/docker.sock`. Will use `$DOCKER_HOST` environment variable if set.|
-|```--save-dir [directory]```| Save exported logs into a custom directory. Defaults to `$HOME`.|
+|```--host [string]```| Connect to Docker with a custom hostname. Defaults to `/var/run/docker.sock`. Will use `$DOCKER_HOST` environment variable if set.|
+|```--save-dir [string]```| Save exported logs into a custom directory. Defaults to `$HOME`.|
 |```--use-cli```| Use the Docker application when exec-ing into a container, instead of the Docker API.|
 
 ## Build step

diff --git a/create_release.sh b/create_release.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 
 # rust create_release
-# v0.3.0
+# v0.3.1
 
 STAR_LINE='****************************************'
 CWD=$(pwd)
@@ -170,6 +170,12 @@ cargo_test () {
 	ask_continue
 }
 
+# Simulate publishing to crates.io
+cargo_publish () {
+	cargo publish --dry-run
+	ask_continue
+}
+
 # Build all releases that GitHub workflow would
 # This will download GB's of docker images
 cargo_build () {
@@ -221,6 +227,7 @@ release_flow() {
 
 	cargo_test
 	cargo_build
+	cargo_publish
 
 	cd "${CWD}" || error_close "Can't find ${CWD}"
 	check_tag