Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -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:
- "*"
14 changes: 7 additions & 7 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Deploy site
name: Deploy

on:
push:
Expand All @@ -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'

Expand All @@ -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'

Expand All @@ -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
Expand All @@ -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
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
31 changes: 27 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,26 @@
# commit-check.com
<div align="center">

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

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)

</div>

Source for [commit-check.com](https://commit-check.com): the landing page, the
blog, and the documentation for every Commit Check project.

## Building locally

Expand Down Expand Up @@ -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).
Loading