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

[Docs] CI for variables.yaml + CI for docs update #2457

Merged
merged 10 commits into from
Jan 29, 2025

Conversation

luarss
Copy link
Contributor

@luarss luarss commented Oct 13, 2024

Tracked in #2452

Fixes #2444

Copy link
Collaborator

@oharboe oharboe left a comment

Choose a reason for hiding this comment

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

Nice! Some nits though.

.github/workflows/github-actions-yaml-test.yml Outdated Show resolved Hide resolved
.github/workflows/github-actions-yaml-test.yml Outdated Show resolved Hide resolved
Copy link
Collaborator

@oharboe oharboe left a comment

Choose a reason for hiding this comment

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

nits

Also, I think it is worth creating a prior pull request that only updates the formatting of variables.yaml so that this PR does not update the variables.yaml, that way you avoid pull request merge conflicts if this PR needs to be hold off.

.github/workflows/github-actions-yaml-test.yml Outdated Show resolved Hide resolved
@luarss luarss marked this pull request as ready for review October 17, 2024 00:35
@luarss luarss marked this pull request as draft October 19, 2024 02:10
@luarss luarss marked this pull request as ready for review November 9, 2024 14:20
Copy link
Collaborator

@oharboe oharboe left a comment

Choose a reason for hiding this comment

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

Suggestion: If FlowVariables.md is modified and it does not match the generatedocs.py result in a PR fail the PR.

@luarss
Copy link
Contributor Author

luarss commented Nov 9, 2024

@oharboe FlowVariables.md changes are detected in the update-pr section. Do you mean to shift it up to the lint section?

@oharboe
Copy link
Collaborator

oharboe commented Nov 9, 2024

I am thinking this is more linting than testing, yes. It is fast enough....

yamlfix.toml Outdated
@@ -0,0 +1,11 @@
explicit_start = true
line_length = 120
Copy link
Member

Choose a reason for hiding this comment

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

It looks like it is being wrapped at 80 characters not 120. 80 is preferable as it match Google style for c++. Does this do anything?

Copy link
Contributor Author

@luarss luarss Nov 9, 2024

Choose a reason for hiding this comment

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

Yes, it does. The command to run for check is yamlfix -c yamlfix.toml flow/scripts/variables.yaml --check, whereas for format is yamlfix -c yamlfix.toml flow/scripts/variables.yaml. Next PR should reflect line length 80.

@luarss luarss marked this pull request as draft January 10, 2025 17:37
luarss added 10 commits January 16, 2025 15:29
Signed-off-by: Jack Luar <jluar@precisioninno.com>
…ction

Signed-off-by: Jack Luar <jluar@precisioninno.com>
Signed-off-by: Jack Luar <jluar@precisioninno.com>
Signed-off-by: Jack Luar <jluar@precisioninno.com>
Signed-off-by: Jack Luar <jluar@precisioninno.com>
Signed-off-by: Jack Luar <jluar@precisioninno.com>
Signed-off-by: Jack Luar <jluar@precisioninno.com>
Signed-off-by: Jack Luar <jluar@precisioninno.com>
Signed-off-by: Jack Luar <jluar@precisioninno.com>
Signed-off-by: Jack Luar <jluar@precisioninno.com>
@luarss luarss marked this pull request as ready for review January 16, 2025 17:44
@luarss luarss requested a review from vvbandeira January 17, 2025 01:51
@vvbandeira vvbandeira enabled auto-merge January 29, 2025 19:53
@vvbandeira vvbandeira requested a review from oharboe January 29, 2025 19:54
Copy link
Collaborator

@oharboe oharboe left a comment

Choose a reason for hiding this comment

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

LGTM

@vvbandeira vvbandeira merged commit 0b17642 into The-OpenROAD-Project:master Jan 29, 2025
7 checks passed
@luarss luarss deleted the topic/yaml-tests branch January 30, 2025 02:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Run flow/scripts/generate-variables-docs.py and create doc update commit as part of OpenROAD bot
4 participants