From 896ae1698c08c00f2ffc5c0a7513526513b04bcd Mon Sep 17 00:00:00 2001 From: hugoalh <32359235+hugoalh@users.noreply.github.com> Date: Tue, 5 Mar 2024 17:11:04 +0800 Subject: [PATCH] Update resources --- .github/ISSUE_TEMPLATE/bug-report.yml | 14 ++-- .../ISSUE_TEMPLATE/documentation-issue.yml | 3 +- .github/labels.yml | 23 ++++++- .github/workflows/map-semver-soft-tag.yml | 4 +- README.md | 67 +++++++++++++------ SECURITY.md | 2 +- 6 files changed, 77 insertions(+), 36 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 5bba322..bcdc084 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -12,8 +12,7 @@ body: description: |- What the bug is? Add images and/or videos to help for explain this bug if needed. - > **ℹ️ Notice:** - > + > [!NOTE] > - Should not blur anything in the images and/or videos, except personal secrets. > - For external images and/or videos, please ensure we are able to view those. placeholder: |- @@ -27,8 +26,7 @@ body: description: |- Is this bug reproducible? If reproducible, please show the required steps by list, images, and/or videos! - > **ℹ️ Notice:** - > + > [!NOTE] > - Should not blur anything in the images and/or videos, except personal secrets. > - For external images and/or videos, please ensure we are able to view those. placeholder: |- @@ -55,10 +53,9 @@ body: description: |- Which versions are affected by this bug? - > **ℹ️ Notice:** - > + > [!NOTE] > - Accept versions range. - > - Versions must be listed as supported in the Security Policy (file: `SECURITY.md`). + > - Versions must be listed as supported in the Security Policy (file `SECURITY.md`). placeholder: |- 1.2.3 validations: @@ -80,8 +77,7 @@ body: - **Variables:** Environment variables. > NO_COLOR=1 / ... - > **ℹ️ Notice:** - > + > [!NOTE] > - Accept multiple execution environments. > - All of the properties are optional. > - It is recommended to provide this information for reproducible steps. diff --git a/.github/ISSUE_TEMPLATE/documentation-issue.yml b/.github/ISSUE_TEMPLATE/documentation-issue.yml index d65fc77..be93a16 100644 --- a/.github/ISSUE_TEMPLATE/documentation-issue.yml +++ b/.github/ISSUE_TEMPLATE/documentation-issue.yml @@ -20,8 +20,7 @@ body: description: |- What the issue is? Add images and/or videos to help for explain this issue if needed. - > **ℹ️ Notice:** - > + > [!NOTE] > - Should not blur anything in the images and/or videos, except personal secrets. > - For external images and/or videos, please ensure we are able to view those. validations: diff --git a/.github/labels.yml b/.github/labels.yml index fa37ffa..178bdd2 100644 --- a/.github/labels.yml +++ b/.github/labels.yml @@ -2,15 +2,18 @@ - name: "Platform/Android" color: "#3DDC84" description: "Related to Android." -- name: "Platform/AssemblyScript" - color: "#007AAC" - description: "Related to AssemblyScript." +- name: "Platform/Bluesky" + color: "#0285FF" + description: "Related to Bluesky." - name: "Platform/Bun" color: "#F9F1E1" description: "Related to Bun." - name: "Platform/ClamAV" color: "#B83033" description: "Related to ClamAV." +- name: "Platform/CloudflareWorkers" + color: "#F38020" + description: "Related to Cloudflare Workers." - name: "Platform/CodeQL" color: "#FFFFFF" description: "Related to CodeQL." @@ -59,9 +62,15 @@ - name: "Platform/GoogleChrome" color: "#4285F4" description: "Related to Google Chrome." +- name: "Platform/Guilded" + color: "#F5C400" + description: "Related to Guilded." - name: "Platform/JavaScript" color: "#F7DF1E" description: "Related to JavaScript." +- name: "Platform/JSR" + color: "#F7DF1E" + description: "Related to JSR (JavaScript Registry)." - name: "Platform/Linux" color: "#FCC624" description: "Related to Linux." @@ -77,6 +86,8 @@ - name: "Platform/MacOS" color: "#000000" description: "Related to MacOS." + aliases: + - "Platform/AppleOS" - name: "Platform/Mastodon" color: "#6364FF" description: "Related to Mastodon." @@ -110,12 +121,18 @@ - name: "Platform/Python" color: "#3776AB" description: "Related to Python." +- name: "Platform/RevoltChat" + color: "#FF4655" + description: "Related to Revolt Chat." - name: "Platform/Roblox" color: "#000000" description: "Related to Roblox." - name: "Platform/RobloxStudio" color: "#00A2FF" description: "Related to Roblox Studio." +- name: "Platform/Rust" + color: "#000000" + description: "Related to Rust." - name: "Platform/Telegram" color: "#26A5E4" description: "Related to Telegram." diff --git a/.github/workflows/map-semver-soft-tag.yml b/.github/workflows/map-semver-soft-tag.yml index 159f92a..93e1c4e 100644 --- a/.github/workflows/map-semver-soft-tag.yml +++ b/.github/workflows/map-semver-soft-tag.yml @@ -9,9 +9,9 @@ jobs: main: name: "Main" permissions: {} - uses: "hugoalh/hugoalh/.github/workflows/call-map-semver-soft-tag-0.yml@main" + uses: "hugoalh/hugoalh/.github/workflows/call-map-semver-soft-tag-1.yml@main" with: - tagspattern_latest: |- + patterns_latest: |- v{{Major}} v{{Major}}.{{Minor}} secrets: diff --git a/README.md b/README.md index 4aefbda..ed1bbe3 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,12 @@ # Disk Space Optimizer (GitHub Action) -[⚖️ MIT](./LICENSE.md) +[**⚖️** MIT](./LICENSE.md) -| | **Release - Latest** | **Release - Pre** | -|:-:|:-:|:-:| -| [![GitHub](https://img.shields.io/badge/GitHub-181717?logo=github&logoColor=ffffff&style=flat-square "GitHub")](https://github.com/hugoalh/disk-space-optimizer-ghaction) | ![GitHub Latest Release Version](https://img.shields.io/github/release/hugoalh/disk-space-optimizer-ghaction?sort=semver&label=&style=flat-square "GitHub Latest Release Version") (![GitHub Latest Release Date](https://img.shields.io/github/release-date/hugoalh/disk-space-optimizer-ghaction?label=&style=flat-square "GitHub Latest Release Date")) | ![GitHub Latest Pre-Release Version](https://img.shields.io/github/release/hugoalh/disk-space-optimizer-ghaction?include_prereleases&sort=semver&label=&style=flat-square "GitHub Latest Pre-Release Version") (![GitHub Latest Pre-Release Date](https://img.shields.io/github/release-date-pre/hugoalh/disk-space-optimizer-ghaction?label=&style=flat-square "GitHub Latest Pre-Release Date")) | +**🗂️** +[![GitHub: hugoalh/disk-space-optimizer-ghaction](https://img.shields.io/badge/hugoalh/disk--space--optimizer--ghaction-181717?logo=github&logoColor=ffffff&style=flat "GitHub: hugoalh/disk-space-optimizer-ghaction")](https://github.com/hugoalh/disk-space-optimizer-ghaction) + +**🆙** ![Latest Release Version](https://img.shields.io/github/release/hugoalh/disk-space-optimizer-ghaction?sort=semver&color=2187C0&label=&style=flat "Latest Release Version") (![Latest Release Date](https://img.shields.io/github/release-date/hugoalh/disk-space-optimizer-ghaction?color=2187C0&label=&style=flat "Latest Release Date")) A GitHub Action to optimize disk space for GitHub hosted runner. @@ -40,30 +41,58 @@ This project is inspired from: - [Pipx packages][list] - [Windows programs (WMIC)][list] -## 🔰 Begin +## 🎯 Target + + + + + + + + +
GitHub Actions + +Runner >= v2.311.0 + +**🛡️ Require Permission:** *N/A* + +**💽 Require Software:** -### GitHub Actions +- PowerShell >= v7.2.0 + +
+ +## 🔰 Usage + +### Composite Action + +1. Import at the metadata (`action.yml`): + ```yml + runs: + using: "composite" + steps: + - uses: "hugoalh/disk-space-optimizer-ghaction@" + ``` -- **Target Version:** Runner >= v2.311.0, &: - - PowerShell >= v7.2.0 -- **Require Permission:** *N/A* +### Workflow -```yml -jobs: - job_id: - runs-on: "________" # Any - steps: - - uses: "hugoalh/disk-space-optimizer-ghaction@" -``` +1. Import at the workflow (`.github/workflows/.yml`): + ```yml + jobs: + job_id: + runs-on: "________" # Any + steps: + - uses: "hugoalh/disk-space-optimizer-ghaction@" + ``` ## 🧩 Input > [!NOTE] > All of the inputs are optional; Use this action without any input will default to do nothing. -| **Legend** | **Description** | -|:-:|:--| -| 🔀 | Switch with groups (e.g.: `{E}`). | +> | **Legend** | **Description** | +> |:-:|:--| +> | 🔀 | Switch with groups (e.g.: `{E}`). | ### `operate_async` diff --git a/SECURITY.md b/SECURITY.md index 0ce18e1..9c1b858 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -15,7 +15,7 @@ | v0.8.X | 🔵 | 2024-01-15 | *N/A* | *Unknown* | >= v2.311.0 | >= v7.2.0 | | v0.7.X | 🟠 | 2023-09-16 | *N/A* | 2024-04-15 | >= v2.308.0 | >= v7.2.0 | -> **ℹ️ Notice:** +> **ℹ️ Note** > > - The date format is according to ISO 8601 standard. > - Values in italic format are subject to change.