feat: Add ignore option

CHANGELOG.md

@@ -11,6 +11,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### Deprecated
 #### Removed
 
+## [1.2.0] - 2025-03-21
+
+### Added
+
+* feat: Add `ignore` input to the github action, enabling to ignore some files when checking the scaffold resources.
+
 ## [1.1.1] - 2025-02-20
 
 ### Fixed

README.md

@@ -113,6 +113,28 @@ jobs:
         uses: Telefonica/opensource-scaffold@v1
 ```
 
+> [!TIP]
+> You can ignore some files when checking the open source resources by providing a list of glob patterns in the `ignore` input. For example, if your repository is a monorepo and you want to ignore the root CHANGELOG.md file, you can omit it by adding `CHANGELOG.md` to the `ignore` input. Read the [inputs](#inputs) section for more information.
+
+#### Inputs
+
+The `opensource-scaffold` action supports the following inputs:
+
+| Name | Description | Type | Required | Default |
+| --- | --- | --- | --- | --- |
+| `log` | The log level to use when running the action | String | No | `info` |
+| `ignore` | A semicolon separated list of glob patterns to ignore files when checking the open source resources | String | No | - |
+
+Example:
+
+```yaml
+- name: Check Open Source scaffold
+  uses: Telefonica/opensource-scaffold@v1
+  with:
+    log: debug
+    ignore: "CHANGELOG.md;**/ISSUE_TEMPLATE/**"
+```
+
 ## The scaffold
 
 Once you initialize an open source project using this scaffold, it will include the following:

action.yml

@@ -19,6 +19,9 @@ inputs:
       - 'silent'
     default: 'info'
     required: false
+  ignore:
+    description: 'List of glob patterns to ignore, semi-colon separated'
+    required: false
 outputs:
   valid:
     description: 'Whether the check passed or not'

action/main.ts

@@ -22,7 +22,12 @@ function valueIfDefined<T = string>(value: T): T | undefined {
 export async function run(): Promise<void> {
   try {
     const log = valueIfDefined((core.getInput("log") as LogLevel) || "");
-    const checker = new Checker({ log });
+    const ignore = valueIfDefined(core.getInput("ignore") || "");
+    const ignorePatterns = ignore
+      ? ignore.split(";").map((ignorePattern) => ignorePattern.trim())
+      : undefined;
+
+    const checker = new Checker({ log, ignore: ignorePatterns });
     const result = await checker.check();
 
     core.setOutput("valid", result.valid.toString());