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

write detailed CHANGELOG.md test #42

Open
timziebart opened this issue Jan 18, 2019 · 0 comments
Open

write detailed CHANGELOG.md test #42

timziebart opened this issue Jan 18, 2019 · 0 comments
Labels
enhancement New feature or request

Comments

@timziebart
Copy link
Member

The current CHANGELOG.md test simply checks whether there has been any change at all, see

- git diff HEAD master --name-only | grep ^CHANGELOG.md$ || (ret=$? && echo -e "${RED}${BOLD}You didn't provide the details of your change in CHANGELOG.md" && exit $ret)

Suggestion: Write a test script (bash, Python, Julia) that checks for the following features:

  • is the Version number given correctly, i.e. the uppermost subheadline should be ## Version a.b where (with the current version being x,y.z) either a==x+1 && b==0 or a==x && b==y+1 holds.
  • are the badges inserted and match the Labels of the PR (bug/bugfix, enhancement)
  • does the description match the PR subject
  • does the link refer to the PR
@timziebart timziebart added the enhancement New feature or request label Jan 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant