https://github.com/fharper/gh-configs

Common configurations for some GitHub Actions I'm using in multiple projects
https://github.com/fharper/gh-configs

Last synced: 24 days ago
JSON representation

Common configurations for some GitHub Actions I'm using in multiple projects

• Host: GitHub
• URL: https://github.com/fharper/gh-configs
• Owner: fharper
• License: unlicense
• Created: 2023-04-18T16:07:00.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-30T20:47:51.000Z (6 months ago)
• Last Synced: 2024-04-30T21:58:51.806Z (6 months ago)
• Language: JavaScript
• Size: 66.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gh-configs

Common configurations for some GitHub Actions I'm using in multiple projects:

- [.markdownlinkcheck.json](.markdownlinkcheck.json): configurations for the [github-action-markdown-link-check](https://github.com/gaurav-nelson/github-action-markdown-link-check) GitHub Action.

- [.markdownlint.json](.markdownlint.json): configurations for the [markdownlint-cli2-action](https://github.com/DavidAnson/markdownlint-cli2-action) GitHub Actions.

It prevents me from having to update all repositories when I change something that should apply to all my repositories (i.e: add a link pattern to ignore when linting Markdown links or enforce a specific rule for Markdown linting).

> I could have sync the files to other repositories when modified versions are pushed to this one, but I want to prevent modifying the configurations directly in a specific repository by mistake, or having an external contributor submitting a change.

## How to use

In the GitHub Actions using one of the configuration file, I'm using the [wget](https://github.com/fharper/wget) GitHub Action as a step to download the configuration file as follow:

```yaml

- name: Download .markdownlint.json

  uses: suisei-cn/[email protected]

  with:

    url: "https://raw.githubusercontent.com/fharper/gh-configs/main/.markdownlint.json"

```