Skip to content

Commit c737325

Browse files
committed
chore: wip
1 parent 2a45edb commit c737325

15 files changed

Lines changed: 1152 additions & 2 deletions

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
- 📊 **Repository statistics** with comprehensive trend analysis
1919
- ⚙️ **Highly configurable** with TypeScript config files
2020
- 🔧 **CLI and programmatic API** for all use cases
21+
- 🤖 **GitHub Action** for automated changelog generation
2122
- 📝 **Conventional commits** parsing and analysis
2223
- 👥 **Author filtering and management**
2324
- 🔗 **Git repository integration** with compare URLs
@@ -78,6 +79,32 @@ console.log(result.content) // Changelog content
7879
console.log(result.outputPath) // Path where changelog was written
7980
```text
8081
82+
### GitHub Action
83+
84+
Use Logsmith in your GitHub workflows:
85+
86+
```yaml
87+
name: Generate Changelog
88+
on:
89+
push:
90+
tags: ['v*']
91+
92+
jobs:
93+
changelog:
94+
runs-on: ubuntu-latest
95+
steps:
96+
- uses: actions/checkout@v4
97+
with:
98+
fetch-depth: 0
99+
100+
- uses: stacksjs/logsmith-action@v0.2.0
101+
with:
102+
output: 'CHANGELOG.md'
103+
theme: 'github'
104+
```
105+
106+
See the [GitHub Action documentation](https://github.com/stacksjs/logsmith/tree/main/packages/action#readme) for more details.
107+
81108
## CLI Commands
82109
83110
### Main Command

bun.lock

Lines changed: 61 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

deps.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
dependencies:
2-
bun.sh: ^1.2.20
2+
bun.sh: ^1.3.0

docs/.vitepress/config.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,12 @@ const sidebar = [
6666
{ text: 'Repository Insights', link: '/features/repository-insights' },
6767
],
6868
},
69+
{
70+
text: 'Integrations',
71+
items: [
72+
{ text: 'GitHub Action', link: '/github-action' },
73+
],
74+
},
6975
{
7076
text: 'Advanced',
7177
items: [

docs/advanced/automation.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,20 @@ Logsmith excels in automated environments because it:
1414

1515
## GitHub Actions
1616

17+
::: tip Use the Official GitHub Action
18+
For the easiest GitHub Actions integration, use the official [Logsmith GitHub Action](/github-action). The examples below show manual CLI usage, but the action provides a simpler, more maintainable approach.
19+
20+
```yaml
21+
- uses: stacksjs/logsmith-action@v0.2.0
22+
with:
23+
theme: 'github'
24+
output: 'CHANGELOG.md'
25+
```
26+
27+
[View full GitHub Action documentation →](/github-action)
28+
:::
29+
30+
1731
### Basic Changelog Generation
1832
1933
```yaml

0 commit comments

Comments
 (0)