Merge pull request #4 from gabrieldonadel/feat/add-required-label-param

feat: Add required-label input

Author: gabrieldonadel

.github/workflows/apply-version-label-issue.yml

@@ -0,0 +1,17 @@
+name: Apply version label to issue
+
+on:
+  issues:
+    types: [opened, edited]
+
+jobs:
+  add-version-label-issue:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          required-label: "Type: Upgrade Issue"

README.md

@@ -1,3 +1,23 @@
 # actions-apply-version-label
 
 GitHub workflow used by the [react-native](https://github.com/facebook/react-native) repository to automatically add `Version: TAG` to issues tagged as `pre-release`.
+
+## Inputs
+
+### `github-token`
+
+**Required** The `GITHUB_TOKEN` secret.
+
+### `required-label`
+
+**Required** The required label for this action to run.
+
+## Example
+
+```
+- uses: gabrieldonadel/[email protected]
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          required-label: "Type: Upgrade Issue"
+```
+

action.yml

@@ -1,5 +1,5 @@
-name: "Apply version label to pre-release issue"
-description: "Automatically apply a version label to issues tagged with pre-release."
+name: "Apply version label to issue"
+description: "Automatically apply a version label to issues tagged with a specific label."
 
 branding:
   icon: "tag"
@@ -9,6 +9,9 @@ inputs:
   github-token:
     description: The `GITHUB_TOKEN` secret.
     required: true
+  required-label:
+    description: The required label for this action to run.
+    required: true
 
 runs:
   using: "node12"

dist/index.js

@@ -8983,6 +8983,7 @@ const getLabelToBeApplied = (version) => version ? `${versionLabel}${version}` :
 const getIsIssueLabelAVersion = (label) => label.startsWith(versionLabel);
 const init = () => __awaiter(void 0, void 0, void 0, function* () {
     const githubToken = core.getInput("github-token", { required: true });
+    const requiredLabel = core.getInput("required-label", { required: true });
     const octokit = github.getOctokit(githubToken);
     const { issue } = github.context;
     // This fetches the issue again as it can have different data after running the other actions
@@ -9008,8 +9009,8 @@ const init = () => __awaiter(void 0, void 0, void 0, function* () {
         repo: issue.repo,
         issue_number: issue.number,
     });
-    if (labels.every(({ name }) => name !== "pre-release")) {
-        core.debug("Issue not tagged with pre-release");
+    if (labels.every(({ name }) => name !== requiredLabel)) {
+        core.debug(`Issue not tagged with ${requiredLabel}`);
         return;
     }
     // Loop through all labels and remove the version label if it exists

src/index.ts

@@ -90,6 +90,7 @@ const getIsIssueLabelAVersion = (label: string) =>
 
 const init = async () => {
   const githubToken = core.getInput("github-token", { required: true });
+  const requiredLabel = core.getInput("required-label", { required: true });
   const octokit = github.getOctokit(githubToken);
 
   const { issue } = github.context;
@@ -123,8 +124,8 @@ const init = async () => {
     issue_number: issue.number,
   });
 
-  if (labels.every(({ name }) => name !== "pre-release")) {
-    core.debug("Issue not tagged with pre-release");
+  if (labels.every(({ name }) => name !== requiredLabel)) {
+    core.debug(`Issue not tagged with ${requiredLabel}`);
 
     return;
   }