Skip to content

Commit 0ddcda0

Browse files
authored
Upgrade gitstats-action version to v1.0.0 (#10)
* Upgrade gitstats-action version to v1.0.0 Updated the GitHub Action version from v0.1.1 to v1.0.0 in the README file for improved stability and features. * Upgrade checkout action from v6 to v7
1 parent 146ee68 commit 0ddcda0

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

‎README.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
A GitHub Action that generates insightful visual reports from Git repositories using [gitstats](https://github.com/shenxianpeng/gitstats).
66

77
> [!TIP]
8-
> Pin to a specific version for stability: `shenxianpeng/gitstats-action@v0.1.1`.
8+
> Pin to a specific version for stability: `shenxianpeng/gitstats-action@v1.0.0`.
99
> Set up an [annotated tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) `v1` pointing to your latest release so users can use `@v1` for automatic minor updates.
1010
1111
## Quick Start
@@ -26,10 +26,10 @@ jobs:
2626
gitstats:
2727
runs-on: ubuntu-latest
2828
steps:
29-
- uses: actions/checkout@v6
29+
- uses: actions/checkout@v7
3030
with:
3131
fetch-depth: 0
32-
- uses: shenxianpeng/gitstats-action@v0.1.1
32+
- uses: shenxianpeng/gitstats-action@v1.0.0
3333
with:
3434
deploy-to-pages: true
3535
```
@@ -57,7 +57,7 @@ Anyone who sees the badge can click it to jump straight to your full GitStats re
5757
**Customizing the badge** — every deploy also publishes a `badges/` directory with one pre-rendered badge per metric, so a different metric is just a different URL: `badges/commits.svg`, `badges/last-commit.svg` (date of the latest commit, e.g. `Aug 2026`), `badges/authors.svg`, `badges/files.svg`, `badges/lines.svg`. Label, color, and shape are controlled through the `config` input:
5858

5959
```yaml
60-
- uses: shenxianpeng/gitstats-action@v0.1.1
60+
- uses: shenxianpeng/gitstats-action@v1.0.0
6161
with:
6262
deploy-to-pages: true
6363
config: badge_metric=last-commit|badge_color=green|badge_style=flat-square
@@ -96,15 +96,15 @@ For full shields.io URL-parameter customization (any color, `style=for-the-badge
9696
### Just generate (no deployment)
9797

9898
```yaml
99-
- uses: shenxianpeng/gitstats-action@v0.1.1
99+
- uses: shenxianpeng/gitstats-action@v1.0.0
100100
with:
101101
output: report
102102
```
103103

104104
### Filter by Date Range
105105

106106
```yaml
107-
- uses: shenxianpeng/gitstats-action@v0.1.1
107+
- uses: shenxianpeng/gitstats-action@v1.0.0
108108
with:
109109
output: report
110110
config: start_date=2024-01-01|end_date=2024-12-31
@@ -113,7 +113,7 @@ For full shields.io URL-parameter customization (any color, `style=for-the-badge
113113
### Custom Config Overrides
114114

115115
```yaml
116-
- uses: shenxianpeng/gitstats-action@v0.1.1
116+
- uses: shenxianpeng/gitstats-action@v1.0.0
117117
with:
118118
output: report
119119
config: project_name=My Project|max_authors=15|exclude_exts=png,jpg,svg
@@ -122,7 +122,7 @@ For full shields.io URL-parameter customization (any color, `style=for-the-badge
122122
### AI-Powered Report
123123

124124
```yaml
125-
- uses: shenxianpeng/gitstats-action@v0.1.1
125+
- uses: shenxianpeng/gitstats-action@v1.0.0
126126
with:
127127
output: report
128128
ai-enabled: 'true'
@@ -135,7 +135,7 @@ For full shields.io URL-parameter customization (any color, `style=for-the-badge
135135
### Custom Deploy Branch
136136

137137
```yaml
138-
- uses: shenxianpeng/gitstats-action@v0.1.1
138+
- uses: shenxianpeng/gitstats-action@v1.0.0
139139
with:
140140
output: report
141141
deploy-to-pages: true
@@ -165,11 +165,11 @@ jobs:
165165
name: github-pages
166166
url: ${{ steps.deployment.outputs.page_url }}
167167
steps:
168-
- uses: actions/checkout@v6
168+
- uses: actions/checkout@v7
169169
with:
170170
fetch-depth: 0
171171
172-
- uses: shenxianpeng/gitstats-action@v0.1.1
172+
- uses: shenxianpeng/gitstats-action@v1.0.0
173173
with:
174174
output: gitstats-report
175175

0 commit comments

Comments
 (0)