Make repo required

Signed-off-by: thepetk <[email protected]>
thepetk · Apr 15, 2024 · e5de685 · e5de685
1 parent a4014b5
commit e5de685
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -4,16 +4,16 @@ A github action that deprecates all devfile registry stack meeting specific depr
 
 ## Inputs
 
-| Name                     | Required | Default          | Description                                                                         |
-| ------------------------ | -------- | ---------------- | ----------------------------------------------------------------------------------- |
-| `registry_repo_token`    | Yes      | None             | 'Token for the registry repo. Can be passed in using `{{ secrets.GITHUB_TOKEN }}`.' |
-| `debug_mode`             | No       | 0                | Sets logging level to DEBUG [0/1].                                                  |
-| `default_branch`         | No       | main             | Default branch of the registry repo.                                                |
-| `deprecation_days_limit` | No       | 365              | Days of inactivity limit for deprecation.                                           |
-| `pr_creation_limit`      | No       | 5                | Limit of PRs created inside a single run.                                           |
-| `registry_repo`          | No       | devfile/registry | The registry github repo.                                                           |
-| `removal_days_limit`     | No       | 365              | Days of inactivity limit for removal.                                               |
-| `stacks_dir`             | No       | stacks           | Stacks dir path.                                                                    |
+| Name                     | Required | Default | Description                                                                         |
+| ------------------------ | -------- | ------- | ----------------------------------------------------------------------------------- |
+| `registry_repo_token`    | Yes      | None    | 'Token for the registry repo. Can be passed in using `{{ secrets.GITHUB_TOKEN }}`.' |
+| `registry_repo`          | Yes      | None    | The registry github repo.                                                           |
+| `debug_mode`             | No       | 0       | Sets logging level to DEBUG [0/1].                                                  |
+| `default_branch`         | No       | main    | Default branch of the registry repo.                                                |
+| `deprecation_days_limit` | No       | 365     | Days of inactivity limit for deprecation.                                           |
+| `pr_creation_limit`      | No       | 5       | Limit of PRs created inside a single run.                                           |
+| `removal_days_limit`     | No       | 365     | Days of inactivity limit for removal.                                               |
+| `stacks_dir`             | No       | stacks  | Stacks dir path.                                                                    |
 
 ## Output
 
@@ -44,10 +44,16 @@ jobs:
         id: deprecate-remove
         uses: thepetk/devfile-registry-maintainer@<version-hash>
         with:
+          # Required inputs
           registry_repo_token: ${{ secrets.GITHUB_TOKEN }}
-          pr_creation_limit: <limit of PRs created per Run>
+          registry_repo: <my-org/username>/<registry-repo-name>
+          # Optional inputs
           deprecation_days_limit: <limit of inactivity days for deprecation>
+          pr_creation_limit: <limit of PRs created per Run>
           removal_days_limit: <limit of inactivity days for removal>
+          debug_mode: <should log on debug leven (0) or info (1)>
+          default_branch: <target branch name>
+          stacks_dir: <path of stacks dir inside the repo>
 ```
 
 ## Releases

diff --git a/action.yaml b/action.yaml
@@ -22,8 +22,7 @@ inputs:
     default: "5"
   registry_repo:
     description: "The path of the registry github repo"
-    required: false
-    default: "thepetk/registry"
+    required: true
   removal_days_limit:
     description: "Days of inactivity limit for removal"
     required: false