Add Changelog script #695

PatOConnor43 · 2018-10-20T04:08:28Z

Resolves #693

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 master 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

Short description of what this PR does:

This PR introduces a generate_changelog.sh script that should take the newest PRs that have not been part of the latest release and creates an entry for them in the CHANGELOG.md file.
This uses the free, unauthenticated Github api to get PR titles. I felt like this was okay since it was the simplest solution and they allow 60 requests per hour this way.

Example usage and output:

./generate_changelog.sh -v 6.0.0 -t 59077e7424629898d6554bc6a0ddcbd768901ae2
Getting title of PR #656
Getting title of PR #636
Getting title of PR #628
Getting title of PR #613
Getting title of PR #619
Getting title of PR #616
Getting title of PR #611
Successfully wrote to CHANGELOG.md

diff

diff --git a/CHANGELOG.md b/CHANGELOG.md
index dd2334b..ad57211 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Change Log
 All notable changes to this project will be documented in this file.
+## [6.0.0] - 2018-10-19 ##
+### Added
+- [PR #656](https://github.com/sendgrid/sendgrid-python/pull/656): Fix helper mail_example redirection link
+- [PR #636](https://github.com/sendgrid/sendgrid-python/pull/636): Fix broken link for mail example
+- [PR #628](https://github.com/sendgrid/sendgrid-python/pull/628): Update README
+- [PR #613](https://github.com/sendgrid/sendgrid-python/pull/613): Update README.md by including email
+- [PR #619](https://github.com/sendgrid/sendgrid-python/pull/619): Fix format of dependency `pytest`
+- [PR #616](https://github.com/sendgrid/sendgrid-python/pull/616): Fix typos
+- [PR #611](https://github.com/sendgrid/sendgrid-python/pull/611): fixes #610
+
 
 ## [5.6.0] - 2018-08-20 ##
 ### Added

If you have questions, please send an email to SendGrid, or file a GitHub Issue in this repository.

SendGridDX · 2018-10-20T04:08:45Z

All committers have signed the CLA.

codecov · 2018-10-20T04:10:53Z

Codecov Report

Merging #695 into master will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #695      +/-   ##
==========================================
+ Coverage   85.03%   85.04%   +0.01%     
==========================================
  Files          35       35              
  Lines        1156     1157       +1     
  Branches      172      172              
==========================================
+ Hits          983      984       +1     
  Misses         90       90              
  Partials       83       83

Impacted Files	Coverage Δ
sendgrid/helpers/mail/validators.py	`44.44% <0%> (ø)`	⬆️
sendgrid/helpers/mail/exceptions.py	`66.66% <0%> (ø)`	⬆️
sendgrid/helpers/inbound/send.py	`93.75% <0%> (ø)`	⬆️
sendgrid/helpers/mail/content.py	`84.61% <0%> (ø)`	⬆️
sendgrid/helpers/inbound/config.py	`97.05% <0%> (+0.08%)`	⬆️

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 cedb4cc...a1fc8c7. Read the comment docs.

PatOConnor43 · 2018-10-20T04:17:22Z

I noticed that this issue was in the java library as well. If this PR gets accepted I can PR it there as well or you can. Whatever's easiest for you.

PatOConnor43 · 2018-10-24T18:46:34Z

@thinkingserious I don't want to be a pain, just don't want this to slip through the cracks. Can I get review on this?

thinkingserious · 2018-10-24T18:49:41Z

This is awesome @PatOConnor43!

I would just say that we should include an option where I can pass our GitHub token in for the API call so that we don't get hit by the rate limiting issue.

PatOConnor43 · 2018-10-24T18:51:33Z

I can definitely do that. I'll get that updated tonight. Thanks!

PatOConnor43 · 2018-10-25T02:25:53Z

@thinkingserious This should be ready for review again. It supports passing in the token with a -t flag or as an env var. It will also fall back to the un-authenticated way if no token is provided.

…ngelog-script

misterdorm

I think this is fine as-is, but I left a few suggestions for improvements if you would like to take those on. Thanks!

misterdorm · 2018-10-30T22:03:16Z

generate_changelog.sh

+    url="$host/$origin/$repo/pull/$pr"
+    api_url="$api_host/repos/$origin/$repo/pulls/$pr"
+    curl_command="curl -s $api_url"
+    if [ "$authorization_token" != "" ]


You can do: if [ -z "$authorization_token" ] instead

misterdorm · 2018-10-30T22:04:05Z

generate_changelog.sh

+    curl_command="curl -s $api_url"
+    if [ "$authorization_token" != "" ]
+      then
+        curl_command="curl -H \"Authorization: token $authorization_token\" -s $api_url"


I would suggest:
curl_command="$curl_command -H \"Authorization: token $authorization_token\""
So there is a single place to update the curl command if needed in the future.

misterdorm · 2018-10-30T22:04:17Z

generate_changelog.sh

+  -v v_content="$content" \
+  '/All notable changes to this project will be documented in this file/{print;print v_header1;print v_header2;print v_content;next}1' CHANGELOG.md \
+  > CHANGELOG.md.temp
+  mv CHANGELOG.md.temp CHANGELOG.md


mv -f just to be sure?

misterdorm · 2018-10-30T22:04:47Z

generate_changelog.sh

+# Generate changelog from last tag
+latest_release="$(git describe --tags --abbrev=0)"
+create_changelog
+echo "Successfully wrote to CHANGELOG.md"


If create_changelog fails for some reason, it would be nice to display an error message, instead of "success" regardless of the outcome.

I added a set -e at the top of the file. I think this should halt the script and print the expected error message. Does that work for you?

PatOConnor43 · 2018-10-30T23:33:45Z

Can do 👍 I'll get this updated tonight

PatOConnor43 · 2018-10-31T04:10:28Z

Thanks for the review @misterdorm. I noticed that this issue was posted in a couple of the sendgrid repos. Would it be helpful for me to make PRs to them as well? I don't want to spam this PR in a bunch of repos if you guys just want to handle it.

misterdorm · 2018-10-31T15:22:18Z

@PatOConnor43 If you want to create PRs in the other repos where someone else hasn't already picked up the issue, please feel free. There are at least a few other repos where others have implemented this, and in those cases it would just be redundant. Thanks!

thinkingserious · 2018-11-02T16:34:04Z

Hello @PatOConnor43,

Thanks again for the PR!

It's HACKTOBERFEST! We want to show our appreciation by sending you some special Hacktoberfest swag. If you have not already, could you please fill out this form so we can send it to you? Thanks!

Team SendGrid DX

PatOConnor43 · 2018-11-07T18:22:45Z

@thinkingserious Any chance I can still get one of those sweet Sendgrid Hacktoberfest shirts for this PR?

childish-sambino · 2020-03-06T19:12:33Z

Closing as we're now using internal tooling for this.

Add Changelog script

472f8ca

thinkingserious added the status: code review request requesting a community code review or review from Twilio label Oct 20, 2018

PatOConnor43 added 2 commits October 24, 2018 18:54

Allow specifying token based on arg or env var

c5cbdb2

Eval the command. Whoops

e88885a

Merge branch 'master' of github.com:sendgrid/sendgrid-python into Cha…

a96faba

…ngelog-script

mr54ndm4n mentioned this pull request Oct 30, 2018

Auto-generate the release notes upon release sendgrid/sendgrid-csharp#795

Closed

misterdorm added status: work in progress Twilio or the community is in the process of implementing hacktoberfest difficulty: hard fix is hard in difficulty and removed status: code review request requesting a community code review or review from Twilio labels Oct 30, 2018

misterdorm approved these changes Oct 30, 2018

View reviewed changes

thinkingserious added type: twilio enhancement feature request on Twilio's roadmap status: waiting for feedback waiting for feedback from the submitter and removed status: work in progress Twilio or the community is in the process of implementing labels Oct 30, 2018

Change if-statements and catch errors

a1fc8c7

misterdorm approved these changes Oct 31, 2018

View reviewed changes

misterdorm added status: work in progress Twilio or the community is in the process of implementing and removed status: waiting for feedback waiting for feedback from the submitter labels Oct 31, 2018

thinkingserious added the status: hacktoberfest approved label Nov 2, 2018

childish-sambino closed this Mar 6, 2020

Add Changelog script #695

Add Changelog script #695

Uh oh!

Conversation

PatOConnor43 commented Oct 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Resolves #693

Checklist

Short description of what this PR does:

Uh oh!

SendGridDX commented Oct 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Oct 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

PatOConnor43 commented Oct 20, 2018

Uh oh!

PatOConnor43 commented Oct 24, 2018

Uh oh!

thinkingserious commented Oct 24, 2018

Uh oh!

PatOConnor43 commented Oct 24, 2018

Uh oh!

PatOConnor43 commented Oct 25, 2018

Uh oh!

misterdorm left a comment

Choose a reason for hiding this comment

Uh oh!

misterdorm Oct 30, 2018

Choose a reason for hiding this comment

Uh oh!

misterdorm Oct 30, 2018

Choose a reason for hiding this comment

Uh oh!

misterdorm Oct 30, 2018

Choose a reason for hiding this comment

Uh oh!

misterdorm Oct 30, 2018

Choose a reason for hiding this comment

Uh oh!

PatOConnor43 Oct 31, 2018

Choose a reason for hiding this comment

Uh oh!

PatOConnor43 commented Oct 30, 2018

Uh oh!

PatOConnor43 commented Oct 31, 2018

Uh oh!

misterdorm commented Oct 31, 2018

Uh oh!

thinkingserious commented Nov 2, 2018

Uh oh!

PatOConnor43 commented Nov 7, 2018

Uh oh!

childish-sambino commented Mar 6, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

PatOConnor43 commented Oct 20, 2018 •

edited

Loading

SendGridDX commented Oct 20, 2018 •

edited

Loading

codecov bot commented Oct 20, 2018 •

edited

Loading