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

[Hackathon Q1 2024] Generate Rules Overview Page #60

Open
wants to merge 51 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
c049f50
Add script to generate Markdown from rules.
brett0000FF Mar 18, 2024
115d69a
Add generated file to .gitignore.
brett0000FF Mar 18, 2024
b1eba5f
Ignore DS_Store.
brett0000FF Mar 18, 2024
86291bb
Rename file. Add workflow.
brett0000FF Mar 18, 2024
8998b44
Test modifying styles folder
brett0000FF Mar 18, 2024
fa37242
Update generate-overview.yml
brett0000FF Mar 18, 2024
8dc50d7
Update generate-overview.yml
brett0000FF Mar 18, 2024
5a90699
Fix run path
brett0000FF Mar 18, 2024
9fd774a
Update rules overview Markdown
actions-user Mar 18, 2024
4f59ee8
Flag Rule Overview page as auto-generated.
brett0000FF Mar 18, 2024
e1f1975
Trigger test
brett0000FF Mar 18, 2024
3f6ac79
Update brett-test.yaml
brett0000FF Mar 18, 2024
1e6cfaf
Remove test.
brett0000FF Mar 18, 2024
53e73fe
Add test pages.
brett0000FF Mar 18, 2024
3cddfee
Update rules overview Markdown
actions-user Mar 18, 2024
6943335
Test edit.
brett0000FF Mar 18, 2024
c385063
Add rules_overview to gitignore.
brett0000FF Mar 18, 2024
35f1d11
Add rules_overview to gitignore.
brett0000FF Mar 18, 2024
84cae7d
Update rules overview Markdown
actions-user Mar 18, 2024
cc003fc
Fix small typo in contributing.md
rtrieu Mar 18, 2024
3f9f0fe
Update action name.
brett0000FF Mar 18, 2024
e3b080b
Tweak names and output.
brett0000FF Mar 18, 2024
37c9718
Fix name.
brett0000FF Mar 18, 2024
7078a17
Update rules page.
actions-user Mar 18, 2024
ff6b7c7
Update commit message.
brett0000FF Mar 18, 2024
7d780c4
Test.
brett0000FF Mar 18, 2024
351bb5a
Update RULES.md - 2024-03-18 UTC.
actions-user Mar 18, 2024
25f08e6
Add description field.
brett0000FF Mar 18, 2024
eef861f
Update gitignore.
brett0000FF Mar 18, 2024
6da2896
Update RULES.md - 2024-03-18.
actions-user Mar 18, 2024
f524ab7
Add description.
brett0000FF Mar 18, 2024
633843f
Update RULES.md - 2024-03-18.
actions-user Mar 18, 2024
1d39a21
Update to on pull request.
brett0000FF Mar 18, 2024
024c46e
Debug.
brett0000FF Mar 18, 2024
77dbe8c
Specify branch.
brett0000FF Mar 18, 2024
f0004b2
Pull before push.
brett0000FF Mar 18, 2024
167d796
Configure rebase.
brett0000FF Mar 18, 2024
1579456
Remove trailing periods in messages.
brett0000FF Mar 18, 2024
25c280c
Update RULES.md - 2024-03-18.
actions-user Mar 18, 2024
d493b3f
Remove test.
brett0000FF Mar 18, 2024
ca7a4c8
Remove tests.
brett0000FF Mar 18, 2024
551b8be
Force add RULES.md.
brett0000FF Mar 18, 2024
bc78238
Update RULES.md - 2024-03-18.
actions-user Mar 18, 2024
acb4570
Update description.
brett0000FF Mar 18, 2024
e9e0aa4
Update RULES.md - 2024-03-18.
actions-user Mar 18, 2024
fc230cd
Test update
brett0000FF Mar 20, 2024
19e4b2f
Update RULES.md - 2024-03-20.
actions-user Mar 20, 2024
6e180a6
Update inclusive.yml
brett0000FF Mar 20, 2024
095db08
Update RULES.md - 2024-03-20.
actions-user Mar 20, 2024
4941c17
Update inclusive.yml
brett0000FF Mar 20, 2024
7c62a16
Update RULES.md - 2024-03-20.
actions-user Mar 20, 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
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
RULES.md linguist-generated=true
39 changes: 39 additions & 0 deletions .github/workflows/update-rules.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Update Rules Page

on:
pull_request:
branches: [main]
paths:
- 'styles/**'
- '.github/workflows/update-rules.yml'

jobs:
generate_markdown:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.x

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install pyyaml

- name: Run script to generate Markdown
run: python scripts/update-rules-page.py

- name: Commit and push changes
run: |
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git add -f RULES.md
TIMESTAMP=$(date -u +"%Y-%m-%d")
git commit -m "Update RULES.md - $TIMESTAMP." || echo "No changes to commit."
git config pull.rebase true
git pull origin ${{ github.head_ref }}
git push origin HEAD:${{ github.head_ref }}
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
Docshtml.zip
Docsmd.zip
.DS_Store
/RULES.md
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Are you interested in contributing your team's product-specific terminology and

1. Create a folder such as `[Product Name]-Names` and add it to the [`Styles/Datadog` folder][4].
2. Update the [CODEOWNERS file][5] with your team's GitHub handle.
3. Update the `StylesPath` to point to the approriate directory in your team repository's [`.vale.ini` file][6].
3. Update the `StylesPath` to point to the appropriate directory in your team repository's [`.vale.ini` file][6].

In order to ease and speed up our review, here are some items you can check for when submitting your pull request:

Expand Down
Loading