From f2071eb8ebd8f1218ad64f98f3fbab8c9096ff0d Mon Sep 17 00:00:00 2001 From: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com> Date: Fri, 16 Oct 2026 18:03:33 +0000 Subject: [PATCH] chore: align README, workflow and Dependabot with the other repositories - README opens with the shared banner, badges and project links, and ends with the same Community section as the CLI. - Deploy site -> Deploy; actions pinned by commit SHA like everywhere else. - Dependabot: monthly, grouped, chore(deps) subjects. - LICENSE holder written the same way in every repository. --- .github/dependabot.yml | 16 ++++++++++------ .github/workflows/deploy.yml | 14 +++++++------- LICENSE | 2 +- README.md | 31 +++++++++++++++++++++++++++---- 4 files changed, 45 insertions(+), 18 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 203f271..069b4ef 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,15 +1,19 @@ -# To get started with Dependabot version updates, you'll need to specify which -# package ecosystems to update and where the package manifests are located. -# Please see the documentation for all configuration options: -# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates +# Dependabot version updates. +# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file +# +# Same shape in every commit-check repository: monthly, one grouped pull +# request per ecosystem, `chore(deps)` commit subjects. version: 2 updates: - package-ecosystem: github-actions directory: / schedule: - interval: "weekly" + interval: monthly + commit-message: + prefix: chore + include: scope groups: - actions: + github-actions: patterns: - "*" diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 7f2b865..05f9b62 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -1,4 +1,4 @@ -name: Deploy site +name: Deploy on: push: @@ -17,11 +17,11 @@ jobs: docs-sync: runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v7 + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 with: persist-credentials: false - - uses: actions/setup-python@v7 + - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 with: python-version: '3.x' @@ -46,11 +46,11 @@ jobs: build: runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v7 + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 with: persist-credentials: false - - uses: actions/setup-python@v7 + - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 with: python-version: '3.x' @@ -63,7 +63,7 @@ jobs: run: pipx run nox -s docs - name: Upload site as pages artifact - uses: actions/upload-pages-artifact@v5 + uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 with: name: ${{ github.event.repository.name }}_site path: ${{ github.workspace }}/site @@ -81,6 +81,6 @@ jobs: steps: - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v5 + uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1 with: artifact_name: ${{ github.event.repository.name }}_site diff --git a/LICENSE b/LICENSE index 83e20c4..bd39101 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2025 Xianpeng Shen (xianpeng.shen@gmail.com) +Copyright (c) 2025 Xianpeng Shen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 081f28c..a1e9001 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,26 @@ -# commit-check.com +
-[![Website](https://img.shields.io/badge/Website-commit--check.com-2c9ccd?labelColor=0b1620&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA2NCA2NCI%2bPHBhdGggZD0iTTIxIDM0TDMwIDQzTDQ3IDIyIiBmaWxsPSJub25lIiBzdHJva2U9IiMyQzlDQ0QiIHN0cm9rZS13aWR0aD0iOCIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIi8%2bPGNpcmNsZSBjeD0iMjEiIGN5PSIzNCIgcj0iNyIgZmlsbD0iIzBCMTYyMCIgc3Ryb2tlPSIjMkM5Q0NEIiBzdHJva2Utd2lkdGg9IjUiLz48L3N2Zz4K)](https://commit-check.com) + + + Commit Check + -Source for [commit-check.com](https://commit-check.com) — the landing page, -the blog, and the documentation for the commit-check family of projects. +**The website, docs and blog for Commit Check.** + +[![Website](https://img.shields.io/badge/Website-commit--check.com-2c9ccd?labelColor=0b1620)](https://commit-check.com) +[![Deploy](https://img.shields.io/github/actions/workflow/status/commit-check/commit-check.com/deploy.yml?branch=main&labelColor=0b1620&label=deploy)](https://github.com/commit-check/commit-check.com/actions/workflows/deploy.yml) + +[Docs](https://commit-check.com/getting-started/) · +[Rules](https://commit-check.com/rules/) · +[CLI](https://github.com/commit-check/commit-check) · +[GitHub Action](https://github.com/commit-check/commit-check-action) · +[GitHub App](https://github.com/apps/commit-check) · +[MCP server](https://github.com/commit-check/commit-check-mcp) + +
+ +Source for [commit-check.com](https://commit-check.com): the landing page, the +blog, and the documentation for every Commit Check project. ## Building locally @@ -49,3 +66,9 @@ alone, so a rule or option cannot change there without this site failing here. Pushes to `main` build and publish to GitHub Pages. Pull requests get a Netlify deploy preview, configured in `netlify.toml`. The custom domain is pinned by `docs/CNAME`, which MkDocs copies to the site root on every build. + +## Community + +Questions and ideas go to [Discussions](https://github.com/commit-check/commit-check/discussions), +bugs and typos on the site to [Issues](https://github.com/commit-check/commit-check.com/issues). +Released under the [MIT License](https://github.com/commit-check/commit-check.com/blob/main/LICENSE).