Update resources

hugoalh · Mar 6, 2024 · c9d4b8d · c9d4b8d
1 parent 17a4f2a
commit c9d4b8d
Show file tree

Hide file tree

Showing 7 changed files with 71 additions and 35 deletions.
diff --git 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
@@ -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
@@ -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/codeql-analysis.yml → .github/workflows/invoke-codeql-analysis.yml b/.github/workflows/codeql-analysis.yml → .github/workflows/invoke-codeql-analysis.yml
@@ -1,5 +1,5 @@
 # yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
-name: "CodeQL Analysis"
+name: "Invoke CodeQL Analysis"
 on:
   push:
     branches:
@@ -17,6 +17,7 @@ jobs:
   main:
     name: "Main"
     permissions:
+      actions: "read"
       contents: "read"
       security-events: "write"
-    uses: "hugoalh/hugoalh/.github/workflows/call-codeql-analysis-0.yml@main"
+    uses: "hugoalh/hugoalh/.github/workflows/call-invoke-codeql-analysis-0.yml@main"
diff --git a/...orkflows/publish-docker-container-ghp.yml → .github/workflows/publish-docker-image.yml b/...orkflows/publish-docker-container-ghp.yml → .github/workflows/publish-docker-image.yml
@@ -1,5 +1,5 @@
 # yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
-name: "Publish Docker Container - GitHub Packages"
+name: "Publish Docker Image"
 on:
   push:
     tags:

diff --git a/README.md b/README.md
@@ -1,10 +1,11 @@
 # Scan Virus (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/scan-virus-ghaction) | ![GitHub Latest Release Version](https://img.shields.io/github/release/hugoalh/scan-virus-ghaction?sort=semver&label=&style=flat-square "GitHub Latest Release Version") (![GitHub Latest Release Date](https://img.shields.io/github/release-date/hugoalh/scan-virus-ghaction?label=&style=flat-square "GitHub Latest Release Date")) | ![GitHub Latest Pre-Release Version](https://img.shields.io/github/release/hugoalh/scan-virus-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/scan-virus-ghaction?label=&style=flat-square "GitHub Latest Pre-Release Date")) |
+**🗂️**
+[![GitHub: hugoalh/scan-virus-ghaction](https://img.shields.io/badge/hugoalh/scan--virus--ghaction-181717?logo=github&logoColor=ffffff&style=flat "GitHub: hugoalh/scan-virus-ghaction")](https://github.com/hugoalh-studio/range-iterator-ts)
+
+**🆙** ![Latest Release Version](https://img.shields.io/github/release/hugoalh/scan-virus-ghaction?sort=semver&color=2187C0&label=&style=flat "Latest Release Version") (![Latest Release Date](https://img.shields.io/github/release-date/hugoalh/scan-virus-ghaction?color=2187C0&label=&style=flat "Latest Release Date"))
 
 A GitHub Action to scan virus (including malicious file and malware).
 
@@ -32,27 +33,49 @@ Some of the communities have publicly published unofficial ClamAV and/or YARA as
 
 This does not provide any guarantee that carefully hidden objects will be scanned. Strong endpoint security, access, and code review policies and practices are the most effective way to ensure that malicious files and/or codes are not introduced. False positives maybe also will be happened.
 
-## 🔰 Begin
+## 🎯 Target
 
-### GitHub Actions
+- GitHub Actions Runner
+  > **🛡️ Require Permission**
+  >
+  > *N/A*
 
-- **Target Version:** >= v2.314.0, &:
-  - Docker
-- **Require Permission:** *N/A*
+  > **💽 Require Software**
+  >
+  > - Docker
 
-```yml
-jobs:
-  job_id:
-    runs-on: "ubuntu-________"
-    steps:
-      - uses: "hugoalh/scan-virus-ghaction@<Tag>"
-```
+## 🔰 Usage
+
+### Composite Action
+
+1. Import at the metadata (`action.yml`):
+    ```yml
+    runs:
+      using: "composite"
+      steps:
+        - uses: "hugoalh/scan-virus-ghaction@<Tag>"
+    ```
+
+### Workflow
+
+1. Import at the workflow (`.github/workflows/<WorkflowName>.yml`):
+    ```yml
+    jobs:
+      job_id:
+        runs-on: "ubuntu-________"
+        steps:
+          - uses: "hugoalh/scan-virus-ghaction@<Tag>"
+    ```
 
 ## 🧩 Input
 
 > [!NOTE]
 > All of the inputs are optional; Use this action without any input will default to scan with the ClamAV official assets.
 
+> | **Legend** | **Description** |
+> |:-:|:--|
+> | 🔐 | Should be an encrypted secret. |
+
 ### `clamav_enable`
 
 `<boolean = true>` Whether to use ClamAV.
@@ -280,7 +303,7 @@ Due to the limitations, this feature is only available when these conditions are
 
 ### `token`
 
-**🔒** `<string = ${{github.token}}>` GitHub token, require for upload the [SARIF report][sarif-github] to the current repository.
+**🔐** `<string = ${{github.token}}>` GitHub token, require for upload the [SARIF report][sarif-github] to the current repository.
 
 ## 🧩 Output
 

diff --git a/SECURITY.md b/SECURITY.md
@@ -15,7 +15,7 @@
 | v0.30.X | 🟤 | *Unknown* | *N/A* | *Unknown* | >= v2.314.0 | Latest Release |
 | v0.20.X | 🔵 | 2023-10-21 | *N/A* | *Unknown* | >= v2.308.0 | Latest Release |
 
-> **ℹ️ Notice:**
+> **ℹ️ Note**
 >
 > - The date format is according to ISO 8601 standard.
 > - Values in italic format are subject to change.