-
Notifications
You must be signed in to change notification settings - Fork 288
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
[Docs] CI for variables.yaml + CI for docs update #2457
Draft
luarss
wants to merge
2
commits into
The-OpenROAD-Project:master
Choose a base branch
from
luarss:topic/yaml-tests
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| name: ORFS variables.yaml tester and linter | ||
|
|
||
| on: | ||
| push: | ||
|
|
||
| jobs: | ||
| docs-test-job: | ||
| name: 'Tests for variables.yaml' | ||
| runs-on: ubuntu-latest | ||
| container: | ||
| image: openroad/ubuntu-cpp20 | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| submodules: 'recursive' | ||
| - name: Run generate-variable-docs.py | ||
| run: | | ||
| python3 flow/scripts/generate-variable-docs.py | ||
| - name: Run yamlfix check | ||
| run: | | ||
| yamlfix -c yamlfix.toml flow/scripts/variables.yaml --check | ||
|
|
||
| docs-pr-update: | ||
| name: 'Create PR to update ORFS FlowVariables.md and variables.yaml' | ||
| needs: | ||
| - docs-test-job | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| - name: Run generate-variable-docs.py | ||
| run: | | ||
| python3 flow/scripts/generate-variable-docs.py | ||
| - name: Run yamlfix | ||
| run: | | ||
| pip install yamlfix==1.17.0 | ||
| yamlfix -c yamlfix.toml flow/scripts/variables.yaml | ||
| - name: Create branch if diff exists | ||
| id: variables-update | ||
| run: | | ||
| git config --local user.email "github-actions[bot]@users.noreply.github.com" | ||
| git config --local user.name "github-actions[bot]" | ||
| if [ -n "$(git status --porcelain)" ]; then | ||
| echo "has_update=true" >> "$GITHUB_OUTPUT" | ||
| else | ||
| echo "has_update=false" >> "$GITHUB_OUTPUT" | ||
| fi | ||
| git add flow/scripts/variables.yaml | ||
| git add docs/user/FlowVariables.md | ||
| git commit --signoff -m "[Docs]: Update ORFS FlowVariables.md" | ||
|
|
||
| # Sanity check that no other files are unstaged | ||
| if [ -n "$(git status --porcelain)" ]; then | ||
| echo "Error: Unstaged changes after commit." | ||
| exit 1 | ||
| fi | ||
| - name: Only push if not master | ||
| if: "github.event.client_payload.branch != 'master'" | ||
| id: variables-update-pr | ||
| run: | | ||
| git push origin "HEAD:refs/pull/${{ github.event.client_payload.branch }}/head" | ||
| - name: Create variables update PR | ||
| if: "steps.variables-update.outputs.has_update == 'true' && github.event.client_payload.branch == 'master'" | ||
| uses: peter-evans/create-pull-request@v5 | ||
| with: | ||
| token: ${{ github.token }} | ||
| signoff: true | ||
| delete-branch: true | ||
| title: "[BOT] Update ORFS variables" | ||
| reviewers: | | ||
| vvbandeira | ||
| maliberty | ||
| draft: true | ||
| branch: bot-update-variables | ||
| commit-message: | | ||
| [BOT] Update ORFS variables | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shouldn't this be pull-request, not on push(to a branch) test linting?
otherwise I don't think it will tests pull requests as only those with write access to the ORFS can create branches
The rest of the PR I think is designed to run after updates to master