diff --git a/.github/workflows/workflow-repo-standards-validation.md b/.github/workflows/workflow-markdown-check.md similarity index 100% rename from .github/workflows/workflow-repo-standards-validation.md rename to .github/workflows/workflow-markdown-check.md diff --git a/.github/workflows/workflow-markdown-check.yml b/.github/workflows/workflow-markdown-check.yml index 2db5e000..0733e651 100644 --- a/.github/workflows/workflow-markdown-check.yml +++ b/.github/workflows/workflow-markdown-check.yml @@ -2,8 +2,12 @@ name: Check Markdown links on: workflow_call: + inputs: + config-file-path: + required: false + type: string push: - + jobs: markdown-link-check: runs-on: ubuntu-latest @@ -13,8 +17,11 @@ jobs: - name: Validating links uses: gaurav-nelson/github-action-markdown-link-check@v1 + with: + config-file: '${{ inputs.config-file-path }}' - - name: Verify line 80 wrap + - name: Run markdown lint uses: DavidAnson/markdownlint-cli2-action@v14 with: - config: .markdownlint.json + fix: true + if: always() # Run step even if previous steps fail. diff --git a/.markdownlint.json b/.markdownlint.json deleted file mode 100644 index 755fa983..00000000 --- a/.markdownlint.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "MD013": { - "line_length": 80 - } - } diff --git a/README.md b/README.md index 1088c607..b2477f24 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,43 @@ # AI-CFIA GitHub Workflows Repository -Welcome to the GitHub Workflows repository of AI-CFIA! This repository contains various GitHub Actions workflows that assist in automating our software development processes. +Welcome to the GitHub Workflows repository of AI-CFIA! This repository +contains various GitHub Actions workflows that assist in automating our +software development processes. ## Overview -This repository is dedicated to providing automated solutions and workflows for various operations within our GitHub projects. It contains a collection of reusable workflows for the CI/CD pipelines, testing, and other automated processes within GitHub Actions. +This repository is dedicated to providing automated solutions and workflows for +various operations within our GitHub projects. It contains a collection of +reusable workflows for the CI/CD pipelines, testing, and other automated +processes within GitHub Actions. -Each workflow has an associated documentation file that explains its purpose, usage, and any required secrets or inputs. You can find these files in the same directory as their corresponding workflow file. +Each workflow has an associated documentation file that explains its +purpose, usage, and any required secrets or inputs. You can find these +files in the same directory as their corresponding workflow file. ## Workflow Documentation Here are the available workflows and their associated documentation: -- [Reusable Docker Container Build](.github/workflows/workflow-build-container.md) -- [Reusable Docker Container Deployment to Google Cloud Run](.github/workflows/workflow-deploy-gcp.md) -- [Reusable Lint and Test Workflow for Node (React) Projects](.github/workflows/workflow-lint-test-node.md) -- [Reusable Lint and Test Workflow for Python Projects](.github/workflows/workflow-lint-test-python.md) -- [Reusable Workflow for Standardization Validation](.github/workflows/workflow-repo-standards-validation.md) -- [Reusable Build and Deploy to GitHub Pages](.github/workflows/workflow-gh-pages-deployment.md) -- [Reusable Vercel Deployment](.github/workflows/workflow-vercel-deployment.md) +- [Reusable Docker Container + Build](.github/workflows/workflow-build-container.md) +- [Reusable Docker Container Deployment to Google Cloud + Run](.github/workflows/workflow-deploy-gcp.md) +- [Reusable Lint and Test Workflow for Node (React) + Projects](.github/workflows/workflow-lint-test-node.md) +- [Reusable Lint and Test Workflow for Python + Projects](.github/workflows/workflow-lint-test-python.md) +- [Reusable Workflow for Standardization + Validation](.github/workflows/workflow-markdown-check.yml) +- [Reusable Build and Deploy to GitHub + Pages](.github/workflows/workflow-gh-pages-deployment.md) +- [Reusable Vercel + Deployment](.github/workflows/workflow-vercel-deployment.md) ## Usage -To use these workflows in your project, you can call them using `workflow_dispatch`. Here’s a basic example of how to call a workflow: +To use these workflows in your project, you can call them using +`workflow_dispatch`. Here’s a basic example of how to call a workflow: ```yaml name: