New version of the template, now adding Remark to check for broken links!

Author: santi100a

.github/workflows/check-md-links.yml

@@ -0,0 +1,19 @@
+name: Check for broken Markdown links
+
+on:
+  schedule:
+    - cron: 0 0 * * *
+  workflow_dispatch: {}
+
+jobs:
+  check-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 19.x
+      - name: Install dependencies
+        run: yarn
+      - name: Run link check 
+        run: yarn check-links

.github/workflows/main.yml renamed to .github/workflows/ci.yml

@@ -17,21 +17,44 @@ jobs:
           node-version: 19.x
           always-auth: true
 
+      - name: Check commit message
+        id: commit
+        run: |
+          COMMIT_MSG=$(/usr/bin/git log --format=%B -n 1 HEAD)
+          STRING=$(echo $COMMIT_MSG | (grep -E "infra:|docs:|lint:|code-style:" || echo ''))
+
+          if [ -z "$STRING" ]; then
+           echo "IS_RELEASE_COMMIT=1" >> $GITHUB_OUTPUT
+           echo "IS_RELEASE_COMMIT=1" >> $GITHUB_ENV
+          else 
+           echo "This commit will NOT trigger a release."
+
+           echo "IS_RELEASE_COMMIT=0" >> $GITHUB_OUTPUT
+           echo "IS_RELEASE_COMMIT=0" >> $GITHUB_ENV
+          fi
+
       - name: Install dependencies
         run: yarn
 
+      - name: Validate Markdown links
+        run: yarn check-links
+
       - name: Validate package.json
         run: yarn validate-package-json
 
       - name: Run ESLint
+        if: env.IS_RELEASE_COMMIT == '1'
         run: yarn lint
 
       - name: Build source code
+        if: env.IS_RELEASE_COMMIT == '1'
         run: yarn build
 
       - name: Run test suites
+        if: env.IS_RELEASE_COMMIT == '1'
         run: yarn test
   release:
+    if: needs.test.outputs.IS_RELEASE_COMMIT == '1'
     permissions:
       contents: write
     needs: test
@@ -94,18 +117,11 @@ jobs:
         run: yarn
       - name: Build code
         run: yarn build
-      # For whatever reason, I have to have a separate secret set to a GitHub PAT to publish
-      # to GPR -- GITHUB_TOKEN won't work, even if I specify:
-      #
-      # permissions:
-      #    packages: write
-      # 
-      # at the top of the workflow/job.
+
       - name: Set authentication token
         run: |
           npm set //npm.pkg.github.com/:_authToken ${{ secrets.GPR_AUTH_TOKEN }}
-      # This step here is a weird workaround to the difference between my NPM and GitHub
-      # usernames. You can delete it if it's causing trouble or it's unnecessary.
+
       - name: Get ready to publish to GPR
         run: |
           jq ".name = \"@$REPO\"" package.json > temp.json && mv temp.json package.json

.github/workflows/issue-welcome.yml

@@ -7,6 +7,7 @@ permissions:
   issues: write
 jobs:
   welcome-author:
+    continue-on-error: true
     runs-on: ubuntu-latest
     steps:
       - name: Say hi

.github/workflows/pr-build-failed.yml

@@ -10,6 +10,7 @@ on:
         type: string
 jobs:
   report-pr-build-failed:
+    continue-on-error: true
     permissions:
       pull-requests: write
     runs-on: ubuntu-latest

.github/workflows/pr-check.yml

@@ -24,25 +24,44 @@ jobs:
         with:
           node-version: 16.x
       - name: Clone the main repo
-        run: cd .. && sudo /usr/bin/git clone https://github.com/${{ github.repository }} main && cd -
-      - name: Check if the PR is acceptable
         run: |
-          diff -q ./tests/ ../main/tests 
-          diff -q ./.github/ ../main/.github
-      - name: Copy test suites from main repo to PR
-        run: cp ../main/tests/*.* tests/
+         cd .. 
+         sudo /usr/bin/git clone https://github.com/${{ github.repository }} main 
+         (cd -) > /dev/null
+
+      - name: Pre-run modified files validation
+        run: |
+         sudo chmod +x scripts/validate-diff.sh 
+         scripts/validate-diff.sh .github ../main/.github
+         scripts/validate-diff.sh LICENSE ../main/LICENSE
+         scripts/validate-diff.sh .gitignore ../main/.gitignore
+         scripts/validate-diff.sh .prettierrc ../main/.prettierrc
+         scripts/validate-diff.sh .eslintrc.json ../main/.eslintrc.json
+         scripts/validate-diff.sh tsconfig.json ../main/tsconfig.json
+         scripts/validate-diff.sh SECURITY.md ../main/SECURITY.md
+         scripts/validate-diff.sh CONTRIBUTING.md ../main/CONTRIBUTING.md
+         scripts/validate-diff.sh CODE_OF_CONDUCT.md ../main/CODE_OF_CONDUCT.md
+
       - name: Get rid of the main repo's clone
         run: sudo rm -rf ../main
-      - name: Validate package.json
-        run: yarn validate-package-json
       - name: Install dependencies
         run: yarn
+
+      - name: Validate package.json
+        run: yarn validate-package-json
+      
+      - name: Validate Markdown links
+        run: yarn check-links
+
       - name: Run ESLint
         run: yarn lint
+        
       - name: Build code
         run: yarn build
+      
       - name: Run main test suites
         run: yarn test
+
       - name: Report build failed (if any)
         if: failure()
         uses: ./.github/workflows/pr-build-failed.yml

.github/workflows/pr-welcome.yml

@@ -6,6 +6,7 @@ on:
 
 jobs:
   say-hi:
+    continue-on-error: true
     permissions:
       pull-requests: write
     runs-on: ubuntu-latest

.remarkrc.json

@@ -0,0 +1,6 @@
+{
+    "plugins": [
+        "gfm",
+        "validate-links"
+    ]
+}

CODE_OF_CONDUCT.md

@@ -5,8 +5,8 @@
 In the interest of fostering an open and welcoming environment, as
 the maintainer, I pledge to make participation in my project and
 our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, level of experience, education, 
-socio-economic status, nationality, personal appearance, race, 
+size, disability, ethnicity, level of experience, education,
+socio-economic status, nationality, personal appearance, race,
 or religion.
 
 ## My Standards
@@ -60,6 +60,7 @@ All complaints will be reviewed and investigated promptly and fairly.
 
 I'm obligated to respect the privacy and security of the
 reporter of any incident.
+
 ## Enforcement Guidelines
 
 I will follow these Community Impact Guidelines in determining
@@ -112,12 +113,12 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 2.0, available at
 <https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
 
-Community Impact Guidelines were inspired by 
+Community Impact Guidelines were inspired by
 [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
 
 For answers to common questions about this code of conduct, see the FAQ at
-<https://www.contributor-covenant.org/faq>. Translations are available 
+<https://www.contributor-covenant.org/faq>. Translations are available
 at <https://www.contributor-covenant.org/translations>.
 
 [homepage]: https://www.contributor-covenant.org
-[Mozilla CoC]: https://github.com/mozilla/diversity
+[Mozilla CoC]: https://github.com/mozilla/diversity

README.md

@@ -6,7 +6,7 @@ You'll find a readme template inside this file.
 In order for the CI workflow's publishing jobs to execute successfully, you must have two
 Actions secrets set up -- `NPM_AUTH_TOKEN` and `GPR_AUTH_TOKEN`.
 They're set to a default dummy value "your-token-here".
-You might want to check the [YAML Actions workflow](.github/workflows/main.yml) for hints
+You might want to check the [YAML Actions workflow](.github/workflows/ci.yml) for hints
 and information you may want or need to know.
 
 ## Template features
@@ -17,7 +17,6 @@ and information you may want or need to know.
 - Automatic testing: Jest.
 - TypeScript 4.9.5 for built-in type definitions and support for compiling to ES3.
 - ESLint and Prettier.
-- A pre-commit hook for prettifying and validation, so you don't get embarrased if your PR's CI fails :)
 - Security policy and contribution guidelines.
 
 - Self-made scripts for verification of package.json and creation of an ESM wrapper
@@ -38,7 +37,7 @@ and information you may want or need to know.
 [![License][license badge]][repo url]
 [![Bundlephobia stats][bundlephobia badge]][bundlephobia url]
 
-[workflow badge]: https://github.com/<author>/<repo>/actions/workflows/main.yml/badge.svg
+[workflow badge]: https://github.com/<author>/<repo>/actions/workflows/ci.yml/badge.svg
 [npm badge]: https://img.shields.io/npm/v/@<author>/<repo>
 [stars badge]: https://img.shields.io/github/stars/<author>/<repo>.svg
 [license badge]: https://img.shields.io/github/license/<author>/<repo>.svg

SECURITY.md

@@ -2,25 +2,31 @@
 
 ## Reporting a Vulnerability
 
-**First see the [Code of Conduct](CODE_OF_CONDUCT.md) and [Contribution instructions](CONTRIBUTE.md)!**
+**First see the [Code of Conduct](CODE_OF_CONDUCT.md) and [Contribution instructions](CONTRIBUTING.md)!**
 
 If you believe you have discovered a security vulnerability in this project, please email me at <[email protected]>. Please include a detailed description of the vulnerability and steps to reproduce it, along with any relevant information on the environment and configuration where the vulnerability was discovered. Please do not disclose the vulnerability publicly until it has been addressed by me.
 
 ## Scope
+
 This security policy applies to all versions of the project, including any pre-release or beta versions. I will make reasonable efforts to address vulnerabilities in a timely manner, but I can make no guarantees whatsoever regarding the timeline or process for addressing vulnerabilities.
 
 ## Responsible Disclosure
+
 I am committed to addressing security vulnerabilities in a responsible manner, and will follow the principles of responsible disclosure:
 
 - I will acknowledge receipt of your vulnerability report as soon as possible.
 - I will provide an estimated timeline for addressing the vulnerability and keep you informed of any changes to the timeline.
 - I will provide credit to you in the release notes for any vulnerability that you report, unless you prefer to remain anonymous.
 - I will not take legal action against you or disclose your identity to any third party without your consent, unless required by law.
+
 ## Vulnerability Severity
+
 I will evaluate the severity of reported vulnerabilities. The severity of the vulnerability will determine the priority for addressing it.
 
 ## Patching
+
 I will try my best to provide patches for all vulnerabilities that are confirmed and accepted. I will make reasonable efforts to provide patches in a timely manner, and will prioritize high-severity vulnerabilities. I may provide workarounds or mitigation advice in cases where a patch is not immediately available.
 
 ## Public Disclosure
-I will coordinate with you to determine an appropriate timeline for public disclosure of the vulnerability, taking into account the severity of the vulnerability, the availability of patches, and any other relevant factors. I will make a best effort to release a patch for the vulnerability before publicly disclosing it, and will coordinate with other affected parties if necessary.
+
+I will coordinate with you to determine an appropriate timeline for public disclosure of the vulnerability, taking into account the severity of the vulnerability, the availability of patches, and any other relevant factors. I will make a best effort to release a patch for the vulnerability before publicly disclosing it, and will coordinate with other affected parties if necessary.