From 1c18394002d4c06e1818262ecdee178d75c38a39 Mon Sep 17 00:00:00 2001 From: Jessica Wilson Date: Wed, 22 Jan 2020 19:34:50 -0800 Subject: [PATCH 1/2] Refactored monolith lists for readability and ease of searching --- README.md | 153 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 92 insertions(+), 61 deletions(-) diff --git a/README.md b/README.md index 4701907..57c79c0 100644 --- a/README.md +++ b/README.md @@ -161,21 +161,13 @@ Set up your GitHub Actions workflow with a specific version of your programming - [Run pandoc](https://github.com/maxheld83/pandoc) - The swiss army knife for document conversions. - [Debug Action](https://github.com/hmarr/debug-action) - Print environment variables and event to the Actions logs. - [Gate actions by filtering if files matching a pattern have been touched](https://github.com/cds-snc/github-actions/tree/master/touched) -- [Scan for secrets in your source code](https://github.com/cds-snc/github-actions/tree/master/seekret) -- [Review the licenses of your node dependencies](https://github.com/cds-snc/github-actions/tree/master/node-license-checker) -- [A GitHub Action to check your project's dependencies](https://github.com/iheanyi/licensed-action) -- [Check if package.json dependencies have changed](https://github.com/bencooper222/check-for-node-dep-changes) -- [Update a repository's "Full description" on Docker Hub](https://github.com/mpepping/github-actions/tree/master/docker-hub-metadata) - [GitHub Actions Badges for your README](https://github.com/atrox/github-actions-badge) - [GitHub Actions for Python project with poetry](https://github.com/abatilo/actions-poetry) - [GitHub Actions to compile LaTeX documents](https://github.com/xu-cheng/latex-action) -- [Create an envfile](https://github.com/SpicyPizza/create-envfile) - [Update Maxmind Databases](https://github.com/meetup/maxmind-updater) - [Debug with SSH over tmate](https://github.com/mxschmitt/action-tmate) - Debug the Action directly by providing a SSH connection. - [Unlock git-crypt files](https://github.com/sliteteam/github-action-git-crypt-unlock) - [Golang CGO cross compiler](https://github.com/crazy-max/ghaction-xgo) -- [Export global environment variables for succeeding build steps](https://github.com/zweitag/github-actions) -- [Programmatically set environment variables for use in subsequent steps](https://github.com/allenevans/set-env) - [Run your job on another architecture: arm32, aarch64 and others](https://github.com/uraimo/run-on-arch-action) - [Generate a table of contents](https://github.com/technote-space/toc-generator) - [Automatically add Label or Assignee to an Issue](https://github.com/Naturalclar/issue-action) @@ -184,62 +176,76 @@ Set up your GitHub Actions workflow with a specific version of your programming - [Publish GitHub release artifacts](https://github.com/skx/github-action-publish-binaries) - [Jekyll Diff Action](https://github.com/David-Byrne/jekyll-diff-action) - Diffs the built Jekyll site after a change, and comments the result back to GitHub. - [Branch Protection Bot](https://github.com/benjefferies/branch-protection-bot) - Temporarily disable and re-enable "Include administrators" option in branch protection. -- [Next SemVers](https://github.com/WyriHaximus/github-action-next-semvers) - Output the next version for major, minor, and patch version based on the given semver version. - [Wait for commit statuses](https://github.com/WyriHaximus/github-action-wait-for-status) - Wait until all statuses and checks are successful or any of them has failed and set its status output accordingly. - [Get Latest Tag](https://github.com/WyriHaximus/github-action-get-previous-tag) - Get the previous tag from git. - [Create Milestone](https://github.com/WyriHaximus/github-action-create-milestone) - Create a new open milestone given the title and description. - [Close Milestone](https://github.com/WyriHaximus/github-action-close-milestone) - Close the given milestone. - [Action to enforce branch naming rules](https://github.com/deepakputhraya/action-branch-name) -- [Install NPM dependencies with caching](https://github.com/bahmutov/npm-install) - [Expose slug of some GitHub variables](https://github.com/marketplace/actions/github-slug) -- [AWS Secrets Manager Actions](https://github.com/say8425/aws-secrets-manager-actions) - Define AWS Secrets Manager secrets to environment values. - [awesome-lint as a GitHub Action](https://github.com/max/awesome-lint) - [Action to lint Awesome lists](https://github.com/squadcastHQ/awesome-lint-action) - Uses [awesome-lint](https://github.com/sindresorhus/awesome-lint) to lint awesome lists as an Action. - [Edit JSON File](https://github.com/deef0000dragon1/json-edit-action) - [Build Slate documentation](https://github.com/Decathlon/slate-builder-action) -- [Get latest SemVer and branch name given a search string](https://github.com/jessicalostinspace/github-action-get-regex-branch) -- [Cut Release Branch](https://github.com/jessicalostinspace/cut-release-action) - Cuts a release branch given a branch prefix and optional semantic version. -- [Generate terraform documentation](https://github.com/Dirrk/terraform-docs) - Uses terraform-docs to generate docs for terraform modules. -- [Increment Semantic Version](https://github.com/christian-draeger/increment-semantic-version) - Bump a given semantic version (SemVer), depending on given release type. - [Read Properties](https://github.com/christian-draeger/read-properties) - Read values from `.properties` files. - [Write Properties](https://github.com/christian-draeger/write-properties) - Write values to `.properties` files. -### Testing and Linting +#### Environments -- [Runs Hadolint against a Dockerfile within a repository](https://github.com/burdzwastaken/hadolint-action) -- [Test your Actions Locally](https://github.com/tschoffelen/gha) -- [Lint a Dockerfile](https://github.com/jwr0/dockerfile-linter-action) (using replicatedhq/dockerfilelint) -- [NPM Audit](https://github.com/JasonEtco/npm-audit-fix-action) -- [PHP Code fixer Action](https://github.com/OskarStark/php-cs-fixer-ga) +- [Create an envfile](https://github.com/SpicyPizza/create-envfile) +- [Export global environment variables for succeeding build steps](https://github.com/zweitag/github-actions) +- [Programmatically set environment variables for use in subsequent steps](https://github.com/allenevans/set-env) + +#### Dependencies + +- [Review the licenses of your node dependencies](https://github.com/cds-snc/github-actions/tree/master/node-license-checker) +- [A GitHub Action to check your project's dependencies](https://github.com/iheanyi/licensed-action) +- [Check if package.json dependencies have changed](https://github.com/bencooper222/check-for-node-dep-changes) +- [Install NPM dependencies with caching](https://github.com/bahmutov/npm-install) + +#### Semantic Versioning + +- [Next SemVers](https://github.com/WyriHaximus/github-action-next-semvers) - Output the next version for major, minor, and patch version based on the given semver version. +- [Get latest SemVer and branch name given a search string](https://github.com/jessicalostinspace/github-action-get-regex-branch) +- [Cut Release Branch](https://github.com/jessicalostinspace/cut-release-action) - Cuts a release branch given a branch prefix and optional semantic version. +- [Increment Semantic Version](https://github.com/christian-draeger/increment-semantic-version) - Bump a given semantic version (SemVer), depending on given release type. + +### Static Analysis + +- [PHPQA toolsuite Action](https://github.com/mickaelandrieu/phpqa-ga) - [PHP Psalm Static code analyzer Action](https://github.com/mickaelandrieu/psalm-ga) - [PHPStan Static code analyzer Action](https://github.com/OskarStark/phpstan-ga) -- [PHPQA toolsuite Action](https://github.com/mickaelandrieu/phpqa-ga) - [GraphQL Inspector Action](https://github.com/kamilkisiela/graphql-inspector) -- [Snyk CLI Test Action](https://github.com/clarkio/snyk-cli-action) - [PowerShell static analysis with PSScriptAnalyzer](https://github.com/devblackops/github-action-psscriptanalyzer) -- [Run web performance audits using Sitespeed.io](https://github.com/sitespeedio/sitespeed.io/tree/master/docker/github-action) +- [Run tfsec, with reviewdog output on the PR](https://github.com/reviewdog/action-tfsec) + +#### Testing + +- [Test your Actions Locally](https://github.com/tschoffelen/gha) +- [Snyk CLI Test Action](https://github.com/clarkio/snyk-cli-action) - [Run Tests through Puppeteer, the Headless Chrome Node API](https://github.com/ianwalter/puppeteer) +- [xUnit Slack Reporter: Sends summary of tests from xUnit reports to a Slack channel](https://github.com/ivanklee86/xunit-slack-reporter) +- [Run codeception tests](https://github.com/joelwmale/codeception-action) +- [Run TestCafe tests](https://github.com/DevExpress/testcafe-action) +- [Run Unity tests](https://github.com/webbertakken/unity-test-runner) +- [Run Cypress E2E tests](https://github.com/cypress-io/github-action) +- [Test Ansible roles with Molecule](https://github.com/robertdebock/molecule-action) + +#### Linting + +- [PHP Code fixer Action](https://github.com/OskarStark/php-cs-fixer-ga) +- [Lint a Dockerfile](https://github.com/jwr0/dockerfile-linter-action) (using replicatedhq/dockerfilelint) +- [Runs Hadolint against a Dockerfile within a repository](https://github.com/burdzwastaken/hadolint-action) - [Run ESLint with status checks and file diff annotations](https://github.com/gimenete/eslint-action) - [Run ESLint, with reviewdog output on the PR](https://github.com/reviewdog/action-eslint) - [JavaScript-based linter for \*.workflow files](https://github.com/OmarTawfik/github-actions-js) -- [Send your latest code coverage score to Coveralls.io](https://github.com/gavinhenderson/coveralls-action) - [Lint a Dockerfile using Hadolint](https://github.com/cds-snc/github-actions/tree/master/docker-lint) - [Lint terraform files using tflint](https://github.com/cds-snc/github-actions/tree/master/tf-lint) - [Lint terraform files using tflint, with reviewdog output on the PR](https://github.com/reviewdog/action-tflint) -- [Run tfsec, with reviewdog output on the PR](https://github.com/reviewdog/action-tfsec) - [Validate Puppet modules using Puppet PDK](https://github.com/mpepping/github-actions/tree/master/pdk-validate) -- [Scan git commits for secrets with gitleaks](https://github.com/eshork/gitleaks-action) -- [Scan code with SonarCloud](https://github.com/sonarsource/sonarcloud-github-action) -- [Send your code coverage to codecov.io](https://github.com/codecov/codecov-action) - [autopep8: Automatically formats Python code to conform to the PEP 8 style guide](https://github.com/peter-evans/autopep8) -- [xUnit Slack Reporter: Sends summary of tests from xUnit reports to a Slack channel](https://github.com/ivanklee86/xunit-slack-reporter) -- [Publishing code coverage to CodeClimate](https://github.com/paambaati/codeclimate-action) -- [Run codeception tests](https://github.com/joelwmale/codeception-action) -- [Audit a webpage with Google Chrome's Lighthouse tests](https://github.com/jakejarvis/lighthouse-action) - [Run `localheinz/composer-normalize` to ensure your PHP project has a normalized `composer.json`](https://github.com/localheinz/composer-normalize-action) - [Run Go lint checks on PR event](https://github.com/ArangoGutierrez/GoLinty-Action) - [Node.js - Automatically run the `format` and/or `lint` script used by the package](https://github.com/MarvinJWendt/run-node-formatter) -- [Continuous Benchmarking and Benchmark Visualization for Go](https://github.com/bobheadxi/gobenchdata) - [Stylelinter - GitHub Action that runs stylelint](https://github.com/exelban/stylelint) - [Run stylelint, with reviewdog output on the PR](https://github.com/reviewdog/action-stylelint) - [PyCodeStyle Action - A GitHub Action that leaves a comment on your PR with pycodestyle (autopep8) feedback](https://github.com/ankitvgupta/pycodestyle-action) @@ -250,21 +256,35 @@ Set up your GitHub Actions workflow with a specific version of your programming - [Run mispell, with reviewdog output on the PR](https://github.com/reviewdog/action-misspell) - [Run golangci-lint, with reviewdog output on the PR](https://github.com/reviewdog/action-golangci-lint) - [Run shellcheck, with reviewdog output on the PR](https://github.com/reviewdog/action-shellcheck) -- [Build Go applications for multiplatform](https://github.com/izumin5210/action-go-crossbuild) - [Catch insensitive, inconsiderate writing in your markdown docs](https://github.com/theashraf/alex-action) -- [Run TestCafe tests](https://github.com/DevExpress/testcafe-action) -- [Run Unity tests](https://github.com/webbertakken/unity-test-runner) -- [Run Cypress E2E tests](https://github.com/cypress-io/github-action) - [Run dotenv-linter - Lints your .env files like a charm, with optional reviewdog output on the PR](https://github.com/wemake-services/dotenv-linter) - [Run dotenv-linter, with reviewdog output on the PR](https://github.com/mgrachev/action-dotenv-linter) - [Show and auto-fix linting errors for many programming languages](https://github.com/samuelmeuli/lint-action) -- [Test Ansible roles with Molecule](https://github.com/robertdebock/molecule-action) -### Security +#### Security +- [NPM Audit](https://github.com/JasonEtco/npm-audit-fix-action) - [A vulnerability scanner for your docker images](https://github.com/phonito/phonito-scanner-action) - [Automatically approve and merge Dependabot updates](https://github.com/ridedott/dependabot-auto-merge-action) - [Run dlint security linter on your Python code](https://github.com/xen0l/dlint-check) +- [Scan git commits for secrets with gitleaks](https://github.com/eshork/gitleaks-action) +- [Scan for secrets in your source code](https://github.com/cds-snc/github-actions/tree/master/seekret) +- [AWS Secrets Manager Actions](https://github.com/say8425/aws-secrets-manager-actions) - Define AWS Secrets Manager secrets to environment values. + +#### Code Coverage + +- [Send your latest code coverage score to Coveralls.io](https://github.com/gavinhenderson/coveralls-action) +- [Scan code with SonarCloud](https://github.com/sonarsource/sonarcloud-github-action) +- [Send your code coverage to codecov.io](https://github.com/codecov/codecov-action) +- [Publishing code coverage to CodeClimate](https://github.com/paambaati/codeclimate-action) + +### Monitoring + +- [Run web performance audits using Sitespeed.io](https://github.com/sitespeedio/sitespeed.io/tree/master/docker/github-action) +- [Audit a webpage with Google Chrome's Lighthouse tests](https://github.com/jakejarvis/lighthouse-action) +- [Runs Lighthouse and posts results to PRs and Slack](https://github.com/foo-software/lighthouse-check-action) +- [Run Lighthouse in CI using GitHub Actions](https://github.com/treosh/lighthouse-ci-action) +- [Continuous Benchmarking and Benchmark Visualization for Go](https://github.com/bobheadxi/gobenchdata) ### Pull Requests @@ -339,14 +359,11 @@ Set up your GitHub Actions workflow with a specific version of your programming - [Deploy to Netlify](https://github.com/netlify/actions) - [Deploy a Probot App using Actions](https://probot.github.io/docs/deployment/#github-actions) - [Deploy a playlist to Spotify](https://github.com/swinton/SpotHub) -- [Deploy a serverless app to AWS Lambda with Up](https://github.com/apex/actions/tree/master/up) -- [Deploy serverless infrastructure with AWS SAM](https://github.com/apex/actions/tree/master/aws/sam) -- [Deploy a Node.js function to AWS Lambda and invoke it using the Serverless framework](https://github.com/swinton/serverless) - [Deploy VS Code extensions with vsce](https://github.com/lannonbr/vsce-action) - [Deploy a Node.js App to Azure](https://github.com/sdras/example-azure-node) - [Deploy via rsync over ssh](https://github.com/maxheld83/ghaction-rsync) -- [Deploy to any Cloud or Kubernetes Using Pulumi](https://github.com/pulumi/actions) - [Deploy a Cloudflare worker](https://github.com/cpilsworth/cloudflare-worker-action) +- [Purge Cloudflare cache after updating a website](https://github.com/jakejarvis/cloudflare-purge-action) - [Deploy your DNS configuration using DNS Control](https://github.com/koenrh/dnscontrol-action) - [Using surge.sh, deploy your branch specific storybook as a pull request deployment](https://github.com/codeship/storybook-surge-github-action) - [Create Release Archive](https://github.com/lubusIN/actions/tree/master/archive) @@ -358,34 +375,52 @@ Set up your GitHub Actions workflow with a specific version of your programming - [GitHub Action for zem](https://github.com/artemnovichkov/action-zem) - [GitHub Action for Homebrew](https://github.com/artemnovichkov/action-homebrew) - [GitHub Action for Homebrew Tap](https://github.com/izumin5210/action-homebrew-tap) -- [Deploy Lambda code to an existing function](https://github.com/appleboy/lambda-action) - [Copy files and artifacts via SSH](https://github.com/appleboy/scp-action) - [Executing remote ssh commands](https://github.com/appleboy/ssh-action) -- [Deploy to Kubernetes with kubectl](https://github.com/steebchen/kubectl) -- [Update a Docker Hub repository description from README.md](https://github.com/peter-evans/dockerhub-description) -- [Purge Cloudflare cache after updating a website](https://github.com/jakejarvis/cloudflare-purge-action) -- [Sync/upload a directory to an AWS S3 bucket](https://github.com/jakejarvis/s3-sync-action) - [Publish a Python distribution package to PyPI](https://github.com/pypa/gh-action-pypi-publish) - [Deploy Static Website to Azure Storage](https://github.com/feeloor/azure-static-website-deploy) - [Cross platform Chocolatey CLI to build and publish packages](https://github.com/crazy-max/ghaction-chocolatey) - [Deploy iOS Pod Library to Cocoapods](https://github.com/michaelhenry/deploy-to-cocoapods-github-action) - [GitHub Action for TencentCloud Serverless](https://github.com/Juliiii/action-scf) - [Publish npm (pre)releases](https://github.com/epeli/npm-release/) -- [Publish Docker Images to the GitHub Package Registry (GPR)](https://github.com/machine-learning-apps/gpr-docker-publish) -- [Get Kubeconfig File From Google Kubernetes Engine (GKE)](https://github.com/machine-learning-apps/gke-kubeconfig) - [Deploy a static site to Surge.sh](https://github.com/yavisht/deploy-via-surge.sh-github-action-template) - [GitHub Action for GoReleaser, a release automation tool for Go projects](https://github.com/goreleaser/goreleaser-action) - [FTP Deploy Action, Deploys a GitHub project to a FTP server using GitHub actions](https://github.com/SamKirkland/FTP-Deploy-Action) - [Publish Article to Dev.to](https://github.com/tylerauerbeck/publish-to-dev.to-action) - [Action For Semantic Release](https://github.com/cycjimmy/semantic-release-action) - [Deploy a Collection to Ansible Galaxy](https://github.com/artis3n/ansible_galaxy_collection) -- [An example of using Terraform to validate and apply GitHub administration](https://github.com/asgharlabs/github-terraform/tree/master/.github/workflows) - [Publish module to Puppet Forge](https://github.com/barnumbirr/action-forge-publish) - [Build and publish Electron apps](https://github.com/samuelmeuli/action-electron-builder) - [Publish a Maven package](https://github.com/samuelmeuli/action-maven-publish) - [Build and deploy a theme to Ghost CMS](https://github.com/TryGhost/action-deploy-theme) - [Deploy an Ansible role to Ansible Galaxy](https://github.com/robertdebock/galaxy-action) +#### Docker + +- [Update a Docker Hub repository description from README.md](https://github.com/peter-evans/dockerhub-description) +- [Publish Docker Images to the GitHub Package Registry (GPR)](https://github.com/machine-learning-apps/gpr-docker-publish) +- [Update a repository's "Full description" on Docker Hub](https://github.com/mpepping/github-actions/tree/master/docker-hub-metadata) + +#### Kubernetes + +- [Deploy to any Cloud or Kubernetes Using Pulumi](https://github.com/pulumi/actions) +- [Deploy to Kubernetes with kubectl](https://github.com/steebchen/kubectl) +- [Get Kubeconfig File From Google Kubernetes Engine (GKE)](https://github.com/machine-learning-apps/gke-kubeconfig) + +#### AWS + +- [Deploy a serverless app to AWS Lambda with Up](https://github.com/apex/actions/tree/master/up) +- [Deploy serverless infrastructure with AWS SAM](https://github.com/apex/actions/tree/master/aws/sam) +- [Deploy a Node.js function to AWS Lambda and invoke it using the Serverless framework](https://github.com/swinton/serverless) +- [Sync/upload a directory to an AWS S3 bucket](https://github.com/jakejarvis/s3-sync-action) +- [Deploy Lambda code to an existing function](https://github.com/appleboy/lambda-action) + +#### Terraform + +- [Generate terraform documentation](https://github.com/Dirrk/terraform-docs) - Uses terraform-docs to generate docs for terraform modules. +- [An example of using Terraform to validate and apply GitHub administration](https://github.com/asgharlabs/github-terraform/tree/master/.github/workflows) + + ### External Services - [Use a Jenkinsfile](https://github.com/jonico/jenkinsfile-runner-github-actions) @@ -409,7 +444,6 @@ Set up your GitHub Actions workflow with a specific version of your programming - [Runs a WebPageTest audit and prints the results as commit comment](https://github.com/JCofman/webPagetestAction) - [GitHub Actions for Hugo extended](https://github.com/peaceiris/actions-hugo) - [Generate OG Image](https://github.com/BoyWithSilverWings/generate-og-image) - Generate customisable open graph images from Markdown files. -- [Runs Lighthouse and posts results to PRs and Slack](https://github.com/foo-software/lighthouse-check-action) - [GitHub Actions for mdBook](https://github.com/peaceiris/actions-mdbook) ### Internet of Things (IOT) @@ -423,18 +457,15 @@ Set up your GitHub Actions workflow with a specific version of your programming - [Query Experiment Tracking Results From Weights & Biases](https://github.com/machine-learning-apps/wandb-action) - [Run Parameterized Jupyter Notebooks](https://github.com/yaananth/run-notebook) -### Performance Monitoring - -- [Run Lighthouse in CI using GitHub Actions](https://github.com/treosh/lighthouse-ci-action) - -### Cheat Sheet - -- [GitHub Actions Branding Cheat Sheet](https://haya14busa.github.io/github-action-brandings/) - ### Build - [run-cmake](https://github.com/lukka/run-cmake) - Multi platform action to build C/C++ software with [CMake](https://cmake.org) and [Ninja](https://ninja-build.org/). - [run-vcpkg](https://github.com/lukka/run-vcpkg) - Multi platform action to build and install C/C++ dependencies with [vcpkg](https://github.com/microsoft/vcpkg). +- [Build Go applications for multiplatform](https://github.com/izumin5210/action-go-crossbuild) + +### Cheat Sheet + +- [GitHub Actions Branding Cheat Sheet](https://haya14busa.github.io/github-action-brandings/) ## Tutorials From e81d9ff8479b3b04928ff3403e1a95f6621bfece Mon Sep 17 00:00:00 2001 From: Jessica Wilson Date: Wed, 22 Jan 2020 19:58:25 -0800 Subject: [PATCH 2/2] Updated Table of Contents to reflect refactor --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 57c79c0..32e42f9 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,8 @@ Actions are triggered by GitHub platform events directly in a repo and run on-de - [GitHub Tools and Management](#github-tools-and-management) - [Collection of Actions](#collection-of-actions) - [Utility](#utility) - - [Testing and Linting](#testing-and-linting) - - [Security](#security) + - [Static Analysis](#static-analysis) + - [Monitoring](#monitoring) - [Pull Requests](#pull-requests) - [GitHub Pages](#github-pages) - [Notifications and Messages](#notifications-and-messages) @@ -30,9 +30,8 @@ Actions are triggered by GitHub platform events directly in a repo and run on-de - [Frontend Tools](#frontend-tools) - [Internet of Things (IOT)](#internet-of-things-iot) - [Machine Learning Ops](#machine-learning-ops) - - [Performance Monitoring](#performance-monitoring) - - [Cheat Sheet](#cheat-sheet) - [Build](#build) + - [Cheat Sheet](#cheat-sheet) - [Tutorials](#tutorials) ## Official Resources