Skip to content

Add simple quality gates to integration tests #33

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

Merged
merged 4 commits into from
Oct 29, 2018

Conversation

sourishkrout
Copy link
Contributor

Description

This PR makes it easier to continuously and quickly gauge simple quality gates such as

  • minimum word/line count per help sections,
  • headline consistency in sections across the documentation, and
  • surfacing any unresolved TODOs.

Minor improvements:

  • Correction of a headline to enforce consistency.
  • Removes dependency to external library to strip tags, use regex instead

Copy link
Collaborator

@maraino maraino left a comment

Choose a reason for hiding this comment

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

Looks good, but can you check my comments first.

for current != nil {
var buf bytes.Buffer
w := io.Writer(&buf)
html.Render(w, current)

notags := strip.StripTags(buf.String())
notags := r.ReplaceAllString(buf.String(), "")
Copy link
Collaborator

Choose a reason for hiding this comment

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

👍

Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you check if the regexp process the the example commands that we have in some files:

step crypto jwe decrypt \< message.json

Copy link
Contributor Author

Choose a reason for hiding this comment

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

👍 Did my due diligence and we're all safe with this regex.

@sourishkrout sourishkrout merged commit 7123990 into master Oct 29, 2018
@sourishkrout sourishkrout deleted the sebastian/help-quality branch October 29, 2018 23:19
maraino added a commit that referenced this pull request Nov 30, 2018
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