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

Fix build: prevent verify-misspelling failing on releases #5643

Merged
merged 1 commit into from
Aug 16, 2018

Conversation

Mikulas
Copy link
Contributor

@Mikulas Mikulas commented Aug 16, 2018

Removes pull request subjects from release notes and checks the remainder of text.

I'd say the pull requests should be listed with the original subjects, even if they include a typo. Very likely the typos are even intentional, such as in

  • [instance_groups.md] typo: recieve->receive AdamDang 5152

It lists files in docs/releases and for each release, it removes lines matching a pull request. Intentionally the files are not changed inplace, as I feel running tests should not change any files. Instead, it writes to .build/docs, because a/ it's already git ignored b/ gets cleaned with make clean

The bash is slightly more convoluted than it seemingly has to be, but it's an intentional workaround macOS sed and it's wrong behavior with -i''.

This changes the output of the misspell command, which may be confusing:

$ make verify-misspelling
./.build/docs/1.10-NOTES.md:50:28: "foo" is a misspelling of "bar"
make: *** [verify-misspelling] Error 1

Note that it says ./.build/docs/1.10-NOTES.md instead of ./docs/releases/1.10-NOTES.md

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Aug 16, 2018
Removes pull request subjects from release notes and checks
the remainder of text.
@Mikulas Mikulas changed the title Prevent verify-misspelling failing on releases Fix build: prevent verify-misspelling failing on releases Aug 16, 2018
@mikesplain
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot removed the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 16, 2018
@mikesplain
Copy link
Contributor

Thanks @Mikulas hmm, I'm not sure which is better, to fix the mispellings or do this...

@mikesplain
Copy link
Contributor

On second review, this is great @Mikulas thanks for the quick fix!

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 16, 2018
@Mikulas
Copy link
Contributor Author

Mikulas commented Aug 16, 2018

@mikesplain Yeah I get that, feel free to close this if it adds too much complexity to the tests.

I honestly started this pull request by changing the release note file first, but it just made little sense to change the pull request labels. Next solution that came to mind was just skipping the 10.0 release notes altogether, but that would not fix future release notes.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mikesplain, Mikulas

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 16, 2018
@mikesplain
Copy link
Contributor

mikesplain commented Aug 16, 2018

@Mikulas This seems right to me, misspelling checking was only added a few months ago so this is our first pass on it. I agree that this, or something like it makes sense. For now, we can get this in and adjust as we go if need be. Thanks again!

@k8s-ci-robot k8s-ci-robot merged commit eae626d into kubernetes:master Aug 16, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants