Skip to content

Commit

Permalink
Update resources
Browse files Browse the repository at this point in the history
  • Loading branch information
hugoalh committed Mar 5, 2024
1 parent ca53494 commit 896ae16
Show file tree
Hide file tree
Showing 6 changed files with 77 additions and 36 deletions.
14 changes: 5 additions & 9 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |-
Expand All @@ -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: |-
Expand All @@ -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:
Expand All @@ -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.
Expand Down
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/documentation-issue.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
23 changes: 20 additions & 3 deletions .github/labels.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down Expand Up @@ -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."
Expand All @@ -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."
Expand Down Expand Up @@ -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."
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/map-semver-soft-tag.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
67 changes: 48 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -40,30 +41,58 @@ This project is inspired from:
- [Pipx packages][list]
- [Windows programs (WMIC)][list]

## 🔰 Begin
## 🎯 Target

<table>
<tbody align="left">
<tr>
<th align="left">GitHub Actions</th>
<td>

Runner >= v2.311.0

**🛡️ Require Permission:** *N/A*

**💽 Require Software:**

### GitHub Actions
- PowerShell >= v7.2.0

</td>
</tr>
</tbody>
</table>

## 🔰 Usage

### Composite Action

1. Import at the metadata (`action.yml`):
```yml
runs:
using: "composite"
steps:
- uses: "hugoalh/disk-space-optimizer-ghaction@<Tag>"
```
- **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@<Tag>"
```
1. Import at the workflow (`.github/workflows/<WorkflowName>.yml`):
```yml
jobs:
job_id:
runs-on: "________" # Any
steps:
- uses: "hugoalh/disk-space-optimizer-ghaction@<Tag>"
```

## 🧩 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`

Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 896ae16

Please sign in to comment.