summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSean E. Russell <ser@ser1.net>2020-05-13 12:31:51 -0500
committerSean E. Russell <ser@ser1.net>2020-05-13 12:31:51 -0500
commit9e4750f7ff5accb610053014155958cb5b7956bd (patch)
treed4bc804c783f404a84dc2ca2c9fe06d0852d1fc3
parent28df77fe42f4c78e51e62a99c467ff6c37c513d4 (diff)
Adds a current-release badge to the README
-rw-r--r--.github/workflows/release.yml18
-rw-r--r--README.md11
-rw-r--r--docs/release.svg8
3 files changed, 34 insertions, 3 deletions
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index a90118a..b158768 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -36,3 +36,21 @@ jobs:
token: ${{ secrets.homebrew }}
formula: gotop
revision: ${{ steps.tag_name.outputs.tag }}
+
+ - name: Update current release badge
+ shell: bash
+ run: sed -i "s/v[0-9]*\.[0-9]*\.[0-9]*/${{steps.tag_name.outputs.tag}}/g" docs/release.svg
+
+ - name: Commit current release badge
+ uses: stefanzweifel/git-auto-commit-action@v4.1.0
+ with:
+ branch: 'master'
+ commit_message: Update release badge to version "${{ steps.tag_name.outputs.tag }}"
+
+ # Optional glob pattern of files which should be added to the commit
+ file_pattern: docs/release.svg
+
+ # Optional commit user and author settings
+ commit_user_name: Badge Updater
+ commit_user_email: ser@ser1.net
+ commit_author: Badge Updater <ser@ser1.net>
diff --git a/README.md b/README.md
index 4d3e571..d2c4b0c 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,14 @@ Another terminal based graphical activity monitor, inspired by [gtop](https://gi
Join us in [\#gotop:matrix.org](https://riot.im/app/#/room/#gotop:matrix.org) ([matrix clients](https://matrix.to/#/#gotop:matrix.org)).
+![](https://github.com/xxxserxxx/gotop/workflows/Build%20Go%20binaries/badge.svg)
+![](https://github.com/xxxserxxx/gotop/workflows/Create%20pre-release/badge.svg)
+
+![](https://github.com/xxxserxxx/gotop/docs/release.svg)
+
+See the [mini-blog](/xxxserxxx/gotop/wiki/blog) for updates on the build status, and the [change log](/xxxserxxx/gotop/blob/master/CHANGELOG.md) for release updates.
+
+
<img src="./assets/screenshots/demo.gif" />
<img src="./assets/screenshots/kitchensink.gif" />
@@ -16,9 +24,6 @@ Join us in [\#gotop:matrix.org](https://riot.im/app/#/room/#gotop:matrix.org) ([
## Installation
-![](https://github.com/xxxserxxx/gotop/workflows/Build%20Go%20binaries/badge.svg)
-![](https://github.com/xxxserxxx/gotop/workflows/Create%20pre-release/badge.svg)
-
Working and tested on Linux, FreeBSD and MacOS. Windows binaries are provided, but have limited testing. OpenBSD works with some caveats; cross-compiling is difficult and binaries are not provided.
If you install gotop by hand, or you download or create new layouts or colorschemes, you will need to put the layout files where gotop can find them. To see the list of directories gotop looks for files, run `gotop -h`. The first directory is always the directory from which gotop is run.
diff --git a/docs/release.svg b/docs/release.svg
new file mode 100644
index 0000000..cb7132a
--- /dev/null
+++ b/docs/release.svg
@@ -0,0 +1,8 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="164" height="20">
+ <a href="/xxxserxxx/gotop/releases/tag/v3.5.2">
+ <text font-size="14pt" fill="#000000" x="5" y="15">
+ Current release: <tspan font-weight="bold">v3.5.2</tspan>
+ </text>
+ </a>
+</svg>
+