Skip to content

Conversation

@benjaminjb
Copy link
Contributor

@benjaminjb benjaminjb commented Sep 27, 2022

Checklist:

  • Have you added an explanation of what your changes do and why you'd like them to be included?
  • Have you updated or added documentation for the change, as applicable?
  • Have you tested your changes on all related environments with successful results, as applicable?
    • Have you added automated tests?

Type of Changes:

  • New feature
  • Bug fix
  • Documentation
  • Testing enhancement
  • Other

What is the current behavior (link to any open issues here)?

What is the new behavior (if this is a feature change)?

  • Breaking change (fix or feature that would cause existing functionality to change)

Other Information:
Issue: [sc-12818]

@benjaminjb benjaminjb marked this pull request as ready for review September 27, 2022 20:19
@benjaminjb benjaminjb force-pushed the crd-doc-update branch 3 times, most recently from 9d3f71e to e712c82 Compare September 27, 2022 21:11
@benjaminjb
Copy link
Contributor Author

benjaminjb commented Sep 27, 2022

Golangci is failing because of trailing spaces in some descriptions (TopologySpreadConstraint.minDomains and grpc.Services)

(I tried changing them by hand rather than producing a patch kustomize file, but that fails the check-generate test.)

Issue: [sc-12818]
@benjaminjb benjaminjb force-pushed the crd-doc-update branch 5 times, most recently from 010be57 to 7872c00 Compare September 28, 2022 12:32
# The `documentation-crd` job only checks the crd.md for `TODO`,
# as some of the upstream documentation has trailing spaces
- run: |
find docs/content/references/crd.md -print0 | xargs -0 awk '
Copy link
Member

Choose a reason for hiding this comment

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

⛏️ maybe find docs/content -name crd.md to complement the other find.

This splits the GH linter action that was checking for
TODOs and trailing spaces in the documentation into two actions:
* one that checks TODOs and trailing spaces in all files except the crd
* one that checks TODOs only in the crd.md file
@benjaminjb benjaminjb merged commit 3951ab8 into CrunchyData:master Sep 28, 2022
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.

2 participants