From d3f06731f14fafecd8931b7259e3c2067489a41a Mon Sep 17 00:00:00 2001 From: Simon Schneegans Date: Sun, 9 Oct 2022 06:44:19 +0200 Subject: [PATCH 1/3] :wrench: Add color range badges --- .github/workflows/badges.yml | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/.github/workflows/badges.yml b/.github/workflows/badges.yml index 697a4b5..df4197e 100644 --- a/.github/workflows/badges.yml +++ b/.github/workflows/badges.yml @@ -21,3 +21,39 @@ jobs: maxColorRange: 100 minColorRange: 0 + color-range-badges: + name: "Create Color Range Badges" + runs-on: ubuntu-latest + strategy: + matrix: + total: + - 0 + - 10 + - 20 + - 30 + - 40 + - 50 + - 60 + - 70 + - 80 + - 90 + - 100 + steps: + - name: "Stagger" + run: | + # Gist returns 500 if we try to update many files in the same gist all at once. + # Thanks to Ned Batchelder for this idea! + # https://nedbatchelder.com/blog/202209/making_a_coverage_badge.html + sleep $( expr ${{ matrix.total }} / 10 ) + - name: "Make badge" + uses: schneegans/dynamic-badges-action@master + with: + auth: ${{ secrets.GIST_SECRET }} + gistID: 2ab8f1d386f13aaebccbd87dac94068d + filename: color_badge_${{ matrix.total }}.json + label: Coverage + message: ${{ matrix.total }}% + minColorRange: 50 + maxColorRange: 90 + valColorRange: ${{ matrix.total }} + From 18582780c1eff4389405d9ccf9bb8b2b3cc57447 Mon Sep 17 00:00:00 2001 From: Simon Schneegans Date: Sun, 9 Oct 2022 06:50:55 +0200 Subject: [PATCH 2/3] :memo: Add color range examples --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 21a8145..f8a2082 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,20 @@ Parameter | Description ### Color Range Parameters (optional) -Starting with version 1.3.0 of this action, the color of the right side of the badge can be computed automatically on a green-to-red color-scale. +Starting with version 1.3.0 of this action, the color of the right side of the badge can be computed automatically on a green-to-red color-scale. For example, these badges have been colored with `minColorRange: 50` and `maxColorRange: 90`: + +[![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d/raw/color_badge_0.json)](https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d) +[![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d/raw/color_badge_10.json)](https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d) +[![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d/raw/color_badge_20.json)](https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d) +[![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d/raw/color_badge_30.json)](https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d) +[![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d/raw/color_badge_40.json)](https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d) +[![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d/raw/color_badge_50.json)](https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d)
+[![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d/raw/color_badge_60.json)](https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d) +[![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d/raw/color_badge_70.json)](https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d) +[![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d/raw/color_badge_80.json)](https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d) +[![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d/raw/color_badge_90.json)](https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d) +[![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d/raw/color_badge_100.json)](https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d) + For this, the following parameters can be used. Parameter | Description @@ -109,7 +122,7 @@ Parameter | Description `colorRangeLightness` | Lightness used by the color range feature. Defaults to 40. -### Using Environment Variables as Parameters [![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d/raw/answer.json)](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d/raw/answer.json) +### Using Environment Variables as Parameters [![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d/raw/answer.json)](https://gist.githubusercontent.com/schneegans/2ab8f1d386f13aaebccbd87dac94068d) A common usage pattern of this action is to create environment variables in previous steps of a job and later use them as message in your badge. How this can be done, is shown in the following example. From f0dea330d9e9dcbc8c9182a1494f6f6ad0c5ac3a Mon Sep 17 00:00:00 2001 From: Simon Schneegans Date: Sun, 9 Oct 2022 06:51:36 +0200 Subject: [PATCH 3/3] :memo: Add changelog entry --- changelog.md | 1 + 1 file changed, 1 insertion(+) diff --git a/changelog.md b/changelog.md index 62bbc4e..9c4b6ca 100644 --- a/changelog.md +++ b/changelog.md @@ -5,6 +5,7 @@ **Release Date:** TBD * The gist is now not updated anymore if the content did not change. This prevents many gist revisions without actual changes. You can restore the original behavior by setting the optional `forceUpdate` parameter to `true`. A BIG thanks to [@MishaKav](https://github.com/MishaKav) for this contribution! +* Example color range badges have been added to the README. * All node dependencies have been updated. ## [Dynamic Badges Action 1.4.0](https://github.com/Schneegans/dynamic-badges-action/tree/v1.4.0)