feat: add support for marking some packages as required

Author: satya164

README.md

@@ -22,11 +22,14 @@ jobs:
   check-versions:
     runs-on: ubuntu-latest
     steps:
-      - uses: react-navigation/check-versions-action@v1
+      - uses: react-navigation/check-versions-action@v1.0.0
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          packages: |
+          required-packages: |
             @react-navigation/native
+          optional-packages: |
+            @react-navigation/bottom-tabs
+            @react-navigation/drawer
             @react-navigation/stack
           missing-versions-label: 'needs more info'
 ```
@@ -39,9 +42,13 @@ Make sure to change the `packages` list and the `missing-versions-label`.
 
 The `GITHUB_TOKEN` secret. This is needed so that we can post comments on the issue.
 
-### `packages` (`required`)
+### `required-packages`
 
-List of packages to check for. The action will match the content of the issue against these package names to find mentioned versions. If there are packages present in the issue, but not mentioned in this list, then they will be ignored.
+List of required packages to check for. The action will match the content of the issue against these package names to find mentioned versions. If the packages are not mentioned or their version is not mentioned in the issue, the action will mark them as missing.
+
+### `optional-packages`
+
+List of optional packages to check for. The action will match the content of the issue against these package names to find mentioned versions. If there are packages present in the issue, but not mentioned in this list, then they will be ignored.
 
 ### `comment`
 

action.yml

@@ -10,9 +10,10 @@ inputs:
   github-token:
     description: The `GITHUB_TOKEN` secret.
     required: true
-  packages:
-    description: 'List of packages to check for'
-    required: true
+  required-packages:
+    description: 'List of optional packages to check for'
+  optional-packages:
+    description: 'List of optional packages to check for'
   comment:
     description: 'Whether to comment on the issue when missing or outdated versions are found'
     default: true

src/check-versions.js

@@ -6,15 +6,22 @@ const REGISTRY = 'https://registry.npmjs.org';
  * Check package versions in the markdown content
  *
  * @param {string} body
- * @param {string[]} packages
+ * @param {string[]} optionalPackages
+ * @param {string[]} requiredPackages
  */
-async function checkVersions(body, packages) {
+async function checkVersions(body, optionalPackages, requiredPackages) {
   const lines = body.split('\n');
 
+  const missing = requiredPackages.reduce((acc, curr) => {
+    acc[curr] = true;
+    return acc;
+  }, {});
+
   const found = {};
-  const missing = {};
   const outdated = {};
 
+  const packages = [...requiredPackages, ...optionalPackages];
+
   for (const line of lines) {
     for (const p of packages) {
       if (line.includes(p)) {
@@ -30,8 +37,8 @@ async function checkVersions(body, packages) {
           if (parts[i] === p) {
             // Strip semver symbols and v prefix
             const version = parts[i + 1]
-              .replace(/^v/, '')
-              .replace(/[\^\~]/, '');
+              ? parts[i + 1].replace(/^v/, '').replace(/[\^\~]/, '')
+              : undefined;
 
             // Check if version matches the proper format
             if (version && /^\d+\.\d+\.\d+/.test(version)) {

src/index.js

@@ -10,21 +10,25 @@ const checkVersions = require('./check-versions');
       core.getInput('github-token', { required: true })
     );
 
-    const packages = core
-      .getInput('packages', { required: true })
+    const optionalPackages = (core.getInput('optional-packages') || '')
+      .split(/\r?\n/)
+      .map((p) => p.trim());
+
+    const requiredPackages = (core.getInput('required-packages') || '')
       .split(/\r?\n/)
       .map((p) => p.trim());
 
     const { found, missing, outdated } = await checkVersions(
       payload.issue.body,
-      packages
+      optionalPackages,
+      requiredPackages
     );
 
     const messages = [];
 
     if (Object.keys(missing).length) {
       messages.push(
-        `Found the following packages mentioned in the issue, but couldn't find version numbers for them:
+        `Couldn't find version numbers for the following packages in the issue:
 ${Object.keys(missing)
   .map((p) => `- \`${p}\``)
   .join('\n')}
@@ -84,6 +88,7 @@ Can you verify that the issue still exists after upgrading to the latest version
 
     core.setOutput('missing', Object.keys(missing).join(','));
   } catch (e) {
-    core.setFailed(error.message);
+    console.log(e);
+    core.setFailed(e.message);
   }
 })();