Merge pull request #15 from tamada/release/v0.1.18

Release/v0.1.18
tamada · Apr 20, 2024 · af19a5a · af19a5a
2 parents f2d4a92 + d8ffd95
commit af19a5a
Show file tree

Hide file tree

Showing 4 changed files with 104 additions and 2 deletions.
diff --git a/.github/workflows/update-version.yaml b/.github/workflows/update-version.yaml
@@ -0,0 +1,42 @@
+name: update_version
+
+on:
+  push:
+    branches:
+      - release/v*
+
+jobs:
+  version-up:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Get tag
+        id: vars
+        run: |
+          echo "GITHUB_REF: $GITHUB_REF"
+          echo "tag=${GITHUB_REF##*/v}" >> $GITHUB_OUTPUT
+          echo "branch=${GITHUB_REF#refs/heads/}" >> $GITHUB_OUTPUT
+
+      - name: Update version
+        run: |
+          sed "s/^version = \".*\"/version = \"${{ steps.vars.outputs.tag }}\"/" Cargo.toml > a ; mv a Cargo.toml
+          sed "s/\$VERSION/${{ steps.vars.outputs.tag }}/g" templates/README.md > a ; mv a README.md
+
+      - name: Initialize Git
+        shell: bash
+        run: |
+          git config --global user.name  "GitHub Actions"
+          git config --global user.email "action@github.com"
+          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
+
+
+      - name: Commit the changes
+        run:  |
+          git commit -a -m "update version to ${{ steps.vars.outputs.tag }}, ready to publish v${{ steps.vars.outputs.tag }}" || true
+
+      - name: Push branch
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ steps.vars.outputs.branch }}
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "totebag"
-version = "0.1.15"
+version = "0.1.18"
 description = "A tool for archiving files and directories and extracting several archive formats."
 repository = "https://github.com/tamada/totebag"
 readme = "README.md"

diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # totebag
 
-[![MIT License](https://shields.io/badge/License-MIT-green)](https://github.com/tamada/totebag/blob/main/LICENSE)
+[![Version](https://shields.io/badge/Version-0.1.18-blue)](https://github.com/tamada/totebag/releases/tag/v0.1.18)
+[![MIT License](https://shields.io/badge/License-MIT-blue)](https://github.com/tamada/totebag/blob/main/LICENSE)
 
 [![build](https://github.com/tamada/totebag/actions/workflows/build.yaml/badge.svg)](https://github.com/tamada/totebag/actions/workflows/build.yaml)
 [![Rust Report Card](https://rust-reportcard.xuri.me/badge/github.com/tamada/totebag)](https://rust-reportcard.xuri.me/report/github.com/tamada/totebag)

diff --git a/templates/README.md b/templates/README.md
@@ -0,0 +1,59 @@
+# totebag
+
+[![Version](https://shields.io/badge/Version-$VERSION-blue)](https://github.com/tamada/totebag/releases/tag/v$VERSION)
+[![MIT License](https://shields.io/badge/License-MIT-blue)](https://github.com/tamada/totebag/blob/main/LICENSE)
+
+[![build](https://github.com/tamada/totebag/actions/workflows/build.yaml/badge.svg)](https://github.com/tamada/totebag/actions/workflows/build.yaml)
+[![Rust Report Card](https://rust-reportcard.xuri.me/badge/github.com/tamada/totebag)](https://rust-reportcard.xuri.me/report/github.com/tamada/totebag)
+[![Coverage Status](https://coveralls.io/repos/github/tamada/totebag/badge.svg)](https://coveralls.io/github/tamada/totebag)
+
+A tool for archiving files and directories and extracting several archive formats.
+
+## Description
+
+There are many archive formats and their tools. The one problem with using each tool is that its interfaces are slightly different.
+Then, The `totebag` treats the archive files as the same interface.
+The tool can extract archive files and archive files and directories.
+
+## Usage
+
+```sh
+totebag [OPTIONS] <ARGUMENTS...>
+OPTIONS
+  -m, --mode <MODE>     Mode of operation. available: extract, archive, and auto.
+                        Default is auto.
+  -d, --dest <DEST>     Destination of the extraction results.
+                        Default is the current directory.
+  -o, --output <FILE>   Output file for the archive.
+                        Default is the totebag.zip.
+                        The archive formats are guessed form extension of the file name.
+      --overwrite       Overwrite the output file if it exists.
+  -v, --verbose         Display verbose output.
+  -h, --help            Display this help message.
+ARGUMENTS
+  extract mode: archive files to be extracted.
+  archive mode: files to be archived.
+  auto mode:    if the arguments have archive files, it will extract them.
+                Otherwise, it will archive the files.
+```
+
+## Install
+
+```sh
+brew install tamada/tap/totebag
+```
+
+## About
+
+### Authors
+
+* Haruaki Tamada ([tamada](https://github.com/tamada/))
+
+### The Logo and the Origin of totebag
+
+The general word, totebag, is a bag for carrying things.
+From this, I chose the name of the tool, totebag, as a tool for packing files and directories carelessly.
+
+![logo](site/assets/logo.jpeg)
+
+This logo was generated by [Bing Image Creator](https://www.bing.com/images/create/e4b880e381a4e381aee3828ae38293e38194e38292e78987e6898be381a7e6bdb0e38199e794b7e381aee6898be3818ce68f8fe3818be3828ce3819fe38388e383bce38388e38390e38383e382b0e381aee58699e79c9f/1-6614ce41dd1c44aeae12e06dec2e8d68?id=W4JmwP3BnK41FZKKFPisSw%3d%3d&view=detailv2&idpp=genimg&thId=OIG3.H3M7RnPEDRZaxzpZJuii&FORM=GCRIDP&ajaxhist=0&ajaxserp=0).