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.

Sign up for GitHub

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

Jump to bottom

Bash script to auto-generate release notes. #112

Merged
merged 3 commits into from
Nov 14, 2018
Merged

Bash script to auto-generate release notes. #112

merged 3 commits into from
Nov 14, 2018

Conversation

shivanshs9
Copy link
Contributor

Closes #108

Checklist

  • I have made a material change to the repo (functionality, testing, spelling, grammar)
  • I have read the [Contribution Guide] and my PR follows them.
  • I updated my branch with the development branch.
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation about the functionality in the appropriate .md file
  • I have added in line documentation to the code I modified
  • I have tested it on my end on bash.

Short description of what this PR does:

  • This PR adds a bash utility to auto-generate release notes, depending on the latest release tag and the current tag.
  • Looks for configured changelog file, by default CHANGELOG.md, and looks for the matching tag names to find the notes to add.
  • Use ./auto-release.sh -h to display help message.

@thinkingserious thinkingserious added the status: code review request requesting a community code review or review from Twilio label Oct 26, 2018
@SendGridDX
Copy link

SendGridDX commented Oct 26, 2018 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@misterdorm misterdorm added status: work in progress Twilio or the community is in the process of implementing difficulty: hard fix is hard in difficulty hacktoberfest and removed status: code review request requesting a community code review or review from Twilio labels Oct 30, 2018
misterdorm
misterdorm requested changes Oct 30, 2018
View reviewed changes
auto_release.sh Outdated

get_latest_tag() {
curl -s $API_RELEASES_URL"/latest" | python3 -c \
"import sys, json; print(json.load(sys.stdin)['tag_name'])" 2>/dev/null
Copy link
Contributor

Choose a reason for hiding this comment

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

Because this is a bash script, it might be cleaner to use the jq tool here instead of inlining python.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I know, but I wasn't sure if it's fine to include an additional dependency in this PR. Python will definitely be installed in the development system, since this is a python client but jq may not be available.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, that's fair.

auto_release.sh Outdated Show resolved Hide resolved
auto_release.sh Outdated Show resolved Hide resolved
@misterdorm @shivanshs9
Update auto_release.sh
477d6f5 
Co-Authored-By: shivanshs9 <[email protected]>
@codecov
Copy link

codecov bot commented Oct 31, 2018 •
edited
Loading

Codecov Report

Merging #112 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #112   +/-   ##
=======================================
  Coverage   91.46%   91.46%           
=======================================
  Files           6        6           
  Lines         293      293           
=======================================
  Hits          268      268           
  Misses         25       25

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a45c299...2b2b33c. Read the comment docs.

@thinkingserious thinkingserious merged commit c49be38 into sendgrid:master Nov 14, 2018
@thinkingserious
Copy link
Contributor

Hello @shivanshs9,

Thanks again for the PR!

We want to show our appreciation by sending you some swag. Could you please fill out this form so we can send it to you? Thanks!

Team SendGrid DX

@shivanshs9
Copy link
Contributor Author

Yep, filled it. Thanks! It feels nice to help the developers, who made sendgrid possible for us!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@misterdorm misterdorm misterdorm approved these changes

Assignees
No one assigned
Labels
difficulty: hard fix is hard in difficulty status: work in progress Twilio or the community is in the process of implementing
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Auto-generate the release notes upon release
4 participants
@shivanshs9 @SendGridDX @thinkingserious @misterdorm