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

Refactor TAG ENV PR QA workflow #269

Merged
merged 23 commits into from
Nov 17, 2023
Merged

Refactor TAG ENV PR QA workflow #269

merged 23 commits into from
Nov 17, 2023

Conversation

guidemetothemoon
Copy link
Contributor

@guidemetothemoon guidemetothemoon commented Nov 11, 2023

  • Moved all QA checks (linting, spelling, links) to GitHub Actions and cleaned up respective scripts, Makefile, etc. GitHub Actions are the 1-1 mapping of the original tool, i.e. either is from the same author or is referenced by the author to use when you want to run the respective tool as a GH Action. All actions run only for modified files, if there are any;
  • Fixed a bunch of dead/broken links and spelling errors;
  • Since cSpell hasn't worked for a while it raised a bunch of errors - improved the way it runs validations by adding custom TAG ENV dictionary with words to ignore, as well as patterns like code blocks in Markdown that we can ignore;
  • Improved link check configuration and fixed findings from it;
  • Added script and NPM command to install and run all the checks locally;
  • Updated documentation to provide more information about QA checks we're running, how to run those locally and how to follow-up on detected issues;

Closes #156 #165

Copy link

netlify bot commented Nov 11, 2023

Deploy Preview for tag-env-sustainability ready!

Name Link
🔨 Latest commit 2effc46
🔍 Latest deploy log https://app.netlify.com/sites/tag-env-sustainability/deploys/655103c6098b8100080fb9cb
😎 Deploy Preview https://deploy-preview-269--tag-env-sustainability.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
Signed-off-by: Kristina Devochko <[email protected]>
@leonardpahlke
Copy link
Member

cc

Signed-off-by: Kristina Devochko <[email protected]>
@guidemetothemoon guidemetothemoon marked this pull request as ready for review November 12, 2023 16:58
@guidemetothemoon guidemetothemoon added kind/bug Something isn't working documentation kind/enhancement New feature or request labels Nov 12, 2023
@guidemetothemoon guidemetothemoon changed the title Refactor QA checks Refactor TAG ENV PR QA workflow Nov 12, 2023
Copy link
Member

@leonardpahlke leonardpahlke left a comment

Choose a reason for hiding this comment

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

💙 LGTM

@leonardpahlke
Copy link
Member

@chalin is this something you are interested in? 😃 (maybe this can serve as a template to restructure some other similar repos)

@guidemetothemoon
Copy link
Contributor Author

@leonardpahlke are we OK to merge this PR or shall I wait a bit more for feedback? 😊

@leonardpahlke leonardpahlke merged commit 7d31413 into main Nov 17, 2023
5 checks passed
@chalin chalin deleted the markdown-linting branch November 17, 2023 14:03
@chalin
Copy link
Collaborator

chalin commented Nov 17, 2023

@chalin is this something you are interested in? 😃 (maybe this can serve as a template to restructure some other similar repos)

Maybe! Will take a look as soon as I can, but it'll likely be 24Q1 or 2 🤷🏼‍♂️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Something isn't working kind/enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[CI] GitHub actions are passing despite fatal errors in workflow scripts
3 participants