Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review workflow #2421

Merged
merged 28 commits into from
Dec 14, 2024
Merged
Show file tree
Hide file tree
Changes from 27 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
cd770d7
Fix menu layout
pipo02mix Oct 31, 2024
ee13014
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 4, 2024
7e58227
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 8, 2024
07259f5
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 11, 2024
8c02bc1
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 22, 2024
32826e9
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 25, 2024
f13d72e
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 26, 2024
4be15bf
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 26, 2024
6a8a7fb
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 28, 2024
5226baa
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 28, 2024
90a3280
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 28, 2024
ec8bf59
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 29, 2024
5bcf3e3
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 29, 2024
f45f5be
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 29, 2024
2d35a47
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 29, 2024
51b76c5
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 29, 2024
240d425
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Nov 29, 2024
e04c77a
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Dec 2, 2024
ce17f5c
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Dec 3, 2024
7032544
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Dec 3, 2024
b3a3f28
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Dec 5, 2024
779e1fb
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Dec 9, 2024
54290f1
Merge branch 'main' of github.com:giantswarm/docs
pipo02mix Dec 12, 2024
286b448
'main' of github.com:giantswarm/docs
pipo02mix Dec 13, 2024
bb865c3
Fix review issues workflow
pipo02mix Dec 13, 2024
5907e76
Small fix
pipo02mix Dec 13, 2024
07074f2
Merge branch 'main' into review-workflow
pipo02mix Dec 13, 2024
fc72147
Merge branch 'main' into review-workflow
pipo02mix Dec 14, 2024
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
11 changes: 6 additions & 5 deletions .github/workflows/generate-review-issues.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Generate review Issues weekly
on:
schedule:
# At 0:00 on Sundays
- cron: '0 0 * * 0'
- cron: '0 0 * * 0'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we change this to any other minute, we won't contribute as much to the typical cronjob load spike in cloud providers.



jobs:
Expand All @@ -16,12 +16,13 @@ jobs:
run: pip3 install click colored PyYAML

- name: Validate front matter and last review date
run: |
echo "ISSUES=$(python3 scripts/validate-front-matter/script.py --validation last-reviewed --output json)" >> $GITHUB_ENV

env:
GITHUB_TOKEN: ${{ secrets.TOKEN }}
run: make validate-last-reviewed

- name: Generate issues of out of date docs
uses: giantswarm/open-issue@7774937e31b23a52257a34462a753b0a28a4d1f1 # 0.3.0
with:
with:
token: ${{ secrets.ISSUE_AUTOMATION }}
org: giantswarm
repo: giantswarm
Expand Down
10 changes: 10 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,16 @@ validate-front-matter:
$(REGISTRY)/$(COMPANY)/docs-scriptrunner:latest \
/workdir/scripts/validate-front-matter/script.py

# Validate front matter for last-reviewed date.
validate-last-reviewed:
docker run --rm \
--volume=${PWD}:/workdir:ro \
-w /workdir \
$(REGISTRY)/$(COMPANY)/docs-scriptrunner:latest \
/workdir/scripts/validate-front-matter/script.py \
--validation last-reviewed \
--output json

# Print a report of pages with a last_review_date that's
# too long ago.
validate-last-reviewed:
Expand Down
3 changes: 2 additions & 1 deletion scripts/validate-front-matter/script.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
crds_path = 'src/content/reference/platform-api/crd'
vintage_crds_path = 'src/content/vintage/use-the-api/management-api/crd'
cluster_apps_path = 'src/content/reference/platform-api/cluster-apps'
meta_path = 'src/content/meta'
docs_host = 'https://github.com/giantswarm/docs/blob/main/'

todays_date = datetime.date.today()
Expand Down Expand Up @@ -161,7 +162,7 @@
{
'id': NO_LAST_REVIEW_DATE,
'description': 'The page should have a last_review_date',
'ignore_paths': [crds_path, vintage_crds_path, changes_path, cluster_apps_path],
'ignore_paths': [crds_path, vintage_path, changes_path, cluster_apps_path, meta_path],
'severity': SEVERITY_WARN,
},
{
Expand Down
Loading