Skip to content

Commit a7b345f

Browse files
authored
chore: align README, workflow and Dependabot with the other repositories (#54)
1 parent f2c59c5 commit a7b345f

4 files changed

Lines changed: 45 additions & 18 deletions

File tree

‎.github/dependabot.yml‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
1-
# To get started with Dependabot version updates, you'll need to specify which
2-
# package ecosystems to update and where the package manifests are located.
3-
# Please see the documentation for all configuration options:
4-
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
1+
# Dependabot version updates.
2+
# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
3+
#
4+
# Same shape in every commit-check repository: monthly, one grouped pull
5+
# request per ecosystem, `chore(deps)` commit subjects.
56

67
version: 2
78
updates:
89
- package-ecosystem: github-actions
910
directory: /
1011
schedule:
11-
interval: "weekly"
12+
interval: monthly
13+
commit-message:
14+
prefix: chore
15+
include: scope
1216
groups:
13-
actions:
17+
github-actions:
1418
patterns:
1519
- "*"

‎.github/workflows/deploy.yml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Deploy site
1+
name: Deploy
22

33
on:
44
push:
@@ -17,11 +17,11 @@ jobs:
1717
docs-sync:
1818
runs-on: ubuntu-24.04
1919
steps:
20-
- uses: actions/checkout@v7
20+
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
2121
with:
2222
persist-credentials: false
2323

24-
- uses: actions/setup-python@v7
24+
- uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
2525
with:
2626
python-version: '3.x'
2727

@@ -46,11 +46,11 @@ jobs:
4646
build:
4747
runs-on: ubuntu-24.04
4848
steps:
49-
- uses: actions/checkout@v7
49+
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
5050
with:
5151
persist-credentials: false
5252

53-
- uses: actions/setup-python@v7
53+
- uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
5454
with:
5555
python-version: '3.x'
5656

@@ -63,7 +63,7 @@ jobs:
6363
run: pipx run nox -s docs
6464

6565
- name: Upload site as pages artifact
66-
uses: actions/upload-pages-artifact@v5
66+
uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
6767
with:
6868
name: ${{ github.event.repository.name }}_site
6969
path: ${{ github.workspace }}/site
@@ -81,6 +81,6 @@ jobs:
8181
steps:
8282
- name: Deploy to GitHub Pages
8383
id: deployment
84-
uses: actions/deploy-pages@v5
84+
uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1
8585
with:
8686
artifact_name: ${{ github.event.repository.name }}_site

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2025 Xianpeng Shen (xianpeng.shen@gmail.com)
3+
Copyright (c) 2025 Xianpeng Shen
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md‎

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,26 @@
1-
# commit-check.com
1+
<div align="center">
22

3-
[![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)
3+
<picture>
4+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/commit-check/.github/main/branding/banner-dark.png">
5+
<img src="https://raw.githubusercontent.com/commit-check/.github/main/branding/banner-light.png" alt="Commit Check">
6+
</picture>
47

5-
Source for [commit-check.com](https://commit-check.com) — the landing page,
6-
the blog, and the documentation for the commit-check family of projects.
8+
**The website, docs and blog for Commit Check.**
9+
10+
[![Website](https://img.shields.io/badge/Website-commit--check.com-2c9ccd?labelColor=0b1620)](https://commit-check.com)
11+
[![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)
12+
13+
[Docs](https://commit-check.com/getting-started/) ·
14+
[Rules](https://commit-check.com/rules/) ·
15+
[CLI](https://github.com/commit-check/commit-check) ·
16+
[GitHub Action](https://github.com/commit-check/commit-check-action) ·
17+
[GitHub App](https://github.com/apps/commit-check) ·
18+
[MCP server](https://github.com/commit-check/commit-check-mcp)
19+
20+
</div>
21+
22+
Source for [commit-check.com](https://commit-check.com): the landing page, the
23+
blog, and the documentation for every Commit Check project.
724

825
## Building locally
926

@@ -49,3 +66,9 @@ alone, so a rule or option cannot change there without this site failing here.
4966
Pushes to `main` build and publish to GitHub Pages. Pull requests get a Netlify
5067
deploy preview, configured in `netlify.toml`. The custom domain is pinned by
5168
`docs/CNAME`, which MkDocs copies to the site root on every build.
69+
70+
## Community
71+
72+
Questions and ideas go to [Discussions](https://github.com/commit-check/commit-check/discussions),
73+
bugs and typos on the site to [Issues](https://github.com/commit-check/commit-check.com/issues).
74+
Released under the [MIT License](https://github.com/commit-check/commit-check.com/blob/main/LICENSE).

0 commit comments

Comments
 (0)