Skip to content

docs: fix version tags, standardize inputs to kebab-case, update readme#7

Open
shenxianpeng wants to merge 2 commits into
mainfrom
chore/update-readme-and-naming
Open

docs: fix version tags, standardize inputs to kebab-case, update readme#7
shenxianpeng wants to merge 2 commits into
mainfrom
chore/update-readme-and-naming

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Jul 4, 2026

Copy link
Copy Markdown
Owner

Summary

Fix version tag references, rename all snake_case inputs to kebab-case, and add missing documentation.

Breaking Changes

All snake_case input names renamed to kebab-case:

Before After
commit_begin commit-start
commit_end commit-end
start_date start-date
end_date end-date
project_name project-name
ai_enabled ai-enabled
ai_provider ai-provider
ai_model ai-model

⚠️ The gitstats config keys (-c commit_begin=... etc.) passed to the underlying tool are unchanged — only the action's input names have been updated.

Changelog

🐛 Bugfix: Version tag references

  • All @v1@v0.1.1 (the actual latest release; v1 tag doesn't exist yet)
  • Added tip about creating a v1 annotated tag for major version tracking

🔧 Refactor: Input naming consistency

  • Renamed all snake_case inputs to kebab-case in action.yml
  • Updated .github/workflows/test.yml references
  • Updated all examples in README.md

📝 Documentation improvements

  • Clarified commit-end default value description
  • Added Custom Deploy Branch example
  • Added Ollama to AI provider list
  • Unified all example indentation

…nch example

- Replace all @v1 references with @v0.1.1 (the actual latest tag)
- Add tip about creating a v1 tag for major version tracking
- Clarify commit_end default description
- Add Custom Deploy Branch example
- List Ollama in AI Insights description
Breaking change: input names renamed for consistency with GitHub Actions convention:
  commit_begin  → commit-start
  commit_end    → commit-end
  start_date    → start-date
  end_date      → end-date
  project_name  → project-name
  ai_enabled    → ai-enabled
  ai_provider   → ai-provider
  ai_model      → ai-model

Update action.yml, README.md, and test.yml accordingly.
The gitstats config keys (-c commit_begin=... etc.) are unchanged.
@shenxianpeng shenxianpeng changed the title docs: fix version tag references, update defaults, and add deploy-branch example docs: fix version tags, standardize inputs to kebab-case, update readme Jul 4, 2026
@shenxianpeng shenxianpeng changed the title docs: fix version tags, standardize inputs to kebab-case, update readme docs: 修复版本标签引用,统一 input 命名为 kebab-case,更新 README Jul 4, 2026
@shenxianpeng shenxianpeng changed the title docs: 修复版本标签引用,统一 input 命名为 kebab-case,更新 README docs: fix version tags, standardize inputs to kebab-case, update readme Jul 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant