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

[CI] Add check for typos #1516

Merged
merged 1 commit into from Nov 15, 2021
Merged

[CI] Add check for typos #1516

merged 1 commit into from Nov 15, 2021

Conversation

Flakebi
Copy link
Member

@Flakebi Flakebi commented Nov 12, 2021

Add a github CI workflow that checks for typos.

Example for a failing run: Flakebi#5

@amdvlk-admin
Copy link
Collaborator

Test summary for commit ae18682

Driver commits used in build
  • CWPACK: amd-master 7387247eb9889ddcabbc1053b9c2052e253b088e
  • METROHASH: amd-master 3c566dd9cda44ca7fd97659e0b53ac953f9037d2
  • PAL: dev 6cc0a035259663610287d8d99262505e78e01db2
  • SPVGEN: dev efa3cec20c6ebc66254ff9cca9b3ea124811d7a3
  • XGL: dev 089c9244e6baa5ed42b1342b391c7c6aec521a2f
  • LLVM-PROJECT: amd-gfx-gpuopen-dev ad9f69a6cf94a03817d1d40bacf1920f31e3c727
CTS tests (Failed: 0/225388)
  • Built with version 1.2.5.2
  • Rhel 8.2, Gfx10
    • Passed: 31425/56347 (55.8%)
    • Failed: 0/56347 (0.0%)
    • Not Supported: 24922/56347 (44.2%)
    Ubuntu 18.04, Gfx9
    • Passed: 31413/56347 (55.7%)
    • Failed: 0/56347 (0.0%)
    • Not Supported: 24934/56347 (44.3%)
    Ubuntu 20.04, Gfx8
    • Passed: 31748/56347 (56.3%)
    • Failed: 0/56347 (0.0%)
    • Not Supported: 24599/56347 (43.7%)
    Ubuntu 20.04, Gfx103
    • Passed: 34582/56347 (61.4%)
    • Failed: 0/56347 (0.0%)
    • Not Supported: 21765/56347 (38.6%)

Copy link
Contributor

@kuhar kuhar left a comment

Choose a reason for hiding this comment

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

Is there a way to run this locally, outside of CI?

@Flakebi
Copy link
Member Author

Flakebi commented Nov 12, 2021

Yes, just install typos and run typos in the llpc repo.

@kuhar
Copy link
Contributor

kuhar commented Nov 12, 2021

Yes, just install typos and run typos in the llpc repo.

Can we make the workflow print such instructions when the check step fails?

@Flakebi
Copy link
Member Author

Flakebi commented Nov 12, 2021

I don’t see an easy way to do this. I tried printing instructions in another step after the spell checking, but you have to expand that step explicitly to see the instructions (see https://github.com/Flakebi/llpc/runs/4191321244?check_suite_focus=true, my step name of Checkout LLPC is not the best but I think it’s well hidden, even if the name would be better).

@kuhar
Copy link
Contributor

kuhar commented Nov 12, 2021

I don’t see an easy way to do this. I tried printing instructions in another step after the spell checking, but you have to expand that step explicitly to see the instructions (see https://github.com/Flakebi/llpc/runs/4191321244?check_suite_focus=true, my step name of Checkout LLPC is not the best but I think it’s well hidden, even if the name would be better).

How about we print those instructions before we run the check step? I'd just like to have something that once can refer to if they see this check fail on their PR.

Add a github CI workflow that checks for typos.
@Flakebi
Copy link
Member Author

Flakebi commented Nov 12, 2021

I named the step “Help”, hopefully that makes it attractive for people to open it.

Copy link
Contributor

@kuhar kuhar left a comment

Choose a reason for hiding this comment

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

LGTM. I'm dyslexic and make tons of typos, tools like this are very helpful.

@JaxLinAMD JaxLinAMD merged commit d6f3edc into GPUOpen-Drivers:dev Nov 15, 2021
@Flakebi Flakebi deleted the typos branch November 15, 2021 10:14
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.

None yet

5 participants