Skip to content

Commit 112a63b

Browse files
committed
Github action to check for upstream community changes
Signed-off-by: Scott Rigby <[email protected]>
1 parent 97a9df9 commit 112a63b

File tree

2 files changed

+71
-0
lines changed

2 files changed

+71
-0
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Update Community Documentation
2+
3+
on:
4+
schedule:
5+
# Run weekly on Mondays at 3 AM UTC
6+
# Adjust frequency as needed - could be nightly: '0 3 * * *'
7+
- cron: '0 3 * * 1'
8+
workflow_dispatch: # Allows manual triggering
9+
10+
permissions:
11+
contents: write
12+
pull-requests: write
13+
14+
jobs:
15+
update-community-docs:
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
- name: Checkout repository
20+
uses: actions/checkout@v4
21+
22+
- name: Setup Node.js
23+
uses: actions/setup-node@v4
24+
with:
25+
node-version-file: '.nvmrc'
26+
cache: 'yarn'
27+
28+
- name: Install dependencies
29+
run: yarn install --frozen-lockfile
30+
31+
- name: Update community docs
32+
run: yarn download-remote-community
33+
34+
- name: Create or Update Pull Request
35+
uses: peter-evans/create-pull-request@v7
36+
with:
37+
token: ${{ secrets.GITHUB_TOKEN }}
38+
commit-message: 'chore(community): update docs from upstream'
39+
signoff: true
40+
title: 'chore(community): update docs from helm/community'
41+
body: |
42+
## 🔄 Automated Community Documentation Update
43+
44+
Updates community documentation from [helm/community](https://github.com/helm/community) repository.
45+
46+
### What this does:
47+
- Downloads latest docs from helm/community
48+
- Applies transformations (frontmatter, links, etc.)
49+
- Creates PR if there are changes
50+
51+
### Review checklist:
52+
- [ ] Verify docs render correctly with `yarn start`
53+
- [ ] Check that no local files were overwritten
54+
55+
---
56+
*This is an automated PR. See `.github/workflows/update-community-docs.yml` for details.*
57+
branch: upstream-community-changes
58+
delete-branch: true
59+
labels: |
60+
docs
61+
community

ARCHITECTURAL_DECISIONS.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -385,6 +385,16 @@ The tradeoff of content duplication is acceptable since these files rarely chang
385385
- `yarn download-remote-community` - Fetch and transform latest content from helm/community repository
386386
- `yarn clear-remote-community` - Remove imported files (useful for testing)
387387

388+
### Automated Updates
389+
390+
A GitHub Action (`.github/workflows/update-community-docs.yml`) runs weekly to:
391+
1. Check for updates in helm/community repository
392+
2. Apply transformations and import changes
393+
3. Create or update a PR if there are changes
394+
4. Skip if an identical PR already exists
395+
396+
The workflow can also be triggered manually through GitHub Actions UI.
397+
388398
### For Contributors
389399

390400
To add new community documents:

0 commit comments

Comments
 (0)