Changelog checkin test: succeed for release PRs #658

dsherry · 2020-04-15T20:46:12Z

Fixes #542

Workaround for changelog checkin test for release PRs: If the 'future release' section is empty of entries with PR refs, mark check as successful

We don't need to update our release process after this PR. But we won't need to do a force-merge next time :)

codecov · 2020-04-15T20:52:31Z

Codecov Report

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

@@           Coverage Diff           @@
##           master     #658   +/-   ##
=======================================
  Coverage   98.97%   98.97%           
=======================================
  Files         136      136           
  Lines        4697     4697           
=======================================
  Hits         4649     4649           
  Misses         48       48

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 5103778...1a8571b. Read the comment docs.

dsherry · 2020-04-15T22:11:43Z

Some proof this change works:

Before I updated the changelog, the changelog test failed
After I updated the changelog, it succeeded
Simulating a release PR locally by deleting all PR entries from the future work section of the changelog and running the cmd produces the expected result of exit 0

jeremyliweishih

Looks good to me - just one comment

jeremyliweishih · 2020-04-15T22:15:22Z

.circleci/config.yml

@@ -190,8 +190,15 @@ jobs:
      - image: busybox:latest
    steps:
      - checkout
-      - run: echo "${CIRCLE_PULL_REQUEST##https://github.com/FeatureLabs/evalml/pull/}"
-      - run: cat docs/source/changelog.rst | grep ":pr:\`${CIRCLE_PULL_REQUEST##https://github.com/FeatureLabs/evalml/pull/}\`"
+      - run: | # debugging info


Was this left intentionally?

Yeah, helpful to have if stuff goes wrong. The comment isn't super necessary but I figured it can't hurt

I agree! Just wanted to make sure

angela97lin

Just a question to make sure I understand but otherwise LGTM! 🛥️

angela97lin · 2020-04-15T22:16:40Z

.circleci/config.yml

-      - run: echo "${CIRCLE_PULL_REQUEST##https://github.com/FeatureLabs/evalml/pull/}"
-      - run: cat docs/source/changelog.rst | grep ":pr:\`${CIRCLE_PULL_REQUEST##https://github.com/FeatureLabs/evalml/pull/}\`"
+      - run: | # debugging info
+          echo $(sed '/^\*\*v/q' docs/source/changelog.rst | grep -iE ":pr:" | wc -l)


Oo just so I understand properly, is this just printing for our sake? Not functionally necessary?

Yeah, just for debug if anything goes wrong later

.circleci/config.yml

… release' section is empty of entries with PR refs, mark check as successful

kmax12 · 2020-04-15T22:35:01Z

@dsherry does this work for the first PR someone makes on a new release? it seems like if the person forgot to add a PR line it wouldn't error in that case since there would be no lines in the future changes

dsherry · 2020-04-15T22:42:37Z

@kmax12 good point, that is true! I guess that's not ideal. The first PR to merge after a release PR goes in will likely be one which was queued up beforehand, meaning the check would have been red. But why make our process more error-prone.

Your saying that made me realize: a more foolproof alternative would be to check the CIRCLE_BRANCH env var and pass the check if that matches "release_v[0-9\.]+", and then always have release PRs use that branching strategy. I think I prefer that approach. Will spend 30min on that.

dsherry · 2020-04-15T22:52:39Z

.circleci/config.yml

+          echo "${CIRCLE_PULL_REQUEST##https://github.com/FeatureLabs/evalml/pull/}"
+      - run: |
+          # for release PRs: if the "future release" segment of the changelog contains no PR refs (sed/grep/wc returns no lines), mark as successful
+          if [[ "${CIRCLE_BRANCH}" =~ "^release_v[0-9\.]+" ]]; then


Ok @jeremyliweishih @angela97lin : RE @kmax12 suggestion I updated this impl to require release branches to be of the form release_vX.X.X (the regex is a bit looser than that but I think that's fine). LMK if you see any issues with that and I can do an update in another PR.

dsherry · 2020-04-15T22:54:33Z

.circleci/config.yml

-      - run: echo "${CIRCLE_PULL_REQUEST##https://github.com/FeatureLabs/evalml/pull/}"
-      - run: cat docs/source/changelog.rst | grep ":pr:\`${CIRCLE_PULL_REQUEST##https://github.com/FeatureLabs/evalml/pull/}\`"
+      - run: | # debugging info
+          [[ "${CIRCLE_BRANCH}" =~ "^release_v[0-9\.]+" ]] && echo This is not a release PR || echo This is a release PR


Used control operators to make this easy to read

dsherry · 2020-04-15T23:18:48Z

Aw man, took 35min, but, got it now 😂 turns out circleci uses sh by default, not bash. That's a headache for another day 🤷‍♂️

dsherry · 2020-04-28T15:00:40Z

Random but I'm pleased to note this worked for the 0.9.0 release!

dsherry force-pushed the ds_542_changelog_check_pass_for_release_prs branch from 057ccf6 to 7a02848 Compare April 15, 2020 22:06

dsherry marked this pull request as ready for review April 15, 2020 22:07

auto-assign bot assigned dsherry Apr 15, 2020

dsherry requested review from angela97lin, jeremyliweishih and christopherbunn April 15, 2020 22:11

jeremyliweishih approved these changes Apr 15, 2020

View reviewed changes

angela97lin approved these changes Apr 15, 2020

View reviewed changes

dsherry commented Apr 15, 2020

View reviewed changes

.circleci/config.yml Show resolved Hide resolved

Workaround for changelog checkin test for release PRs: If the 'future…

b91450f

… release' section is empty of entries with PR refs, mark check as successful

dsherry force-pushed the ds_542_changelog_check_pass_for_release_prs branch from 48573cf to b91450f Compare April 15, 2020 22:24

dsherry added 2 commits April 15, 2020 18:48

Use branch name instead

03b6554

Update releasing instructions with branching pattern

a7abaf0

dsherry commented Apr 15, 2020

View reviewed changes

dsherry added 2 commits April 15, 2020 18:56

Inverted logic in print

ba01631

Fix impl

81c6197

dsherry force-pushed the ds_542_changelog_check_pass_for_release_prs branch from 727f995 to 81c6197 Compare April 15, 2020 23:14

Update comment

1a8571b

dsherry merged commit 6e5553b into master Apr 15, 2020

dsherry deleted the ds_542_changelog_check_pass_for_release_prs branch April 15, 2020 23:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changelog checkin test: succeed for release PRs #658

Changelog checkin test: succeed for release PRs #658

dsherry commented Apr 15, 2020 •

edited

Loading

codecov bot commented Apr 15, 2020 •

edited

Loading

dsherry commented Apr 15, 2020

jeremyliweishih left a comment

jeremyliweishih Apr 15, 2020

dsherry Apr 15, 2020

jeremyliweishih Apr 15, 2020

angela97lin left a comment

angela97lin Apr 15, 2020

dsherry Apr 15, 2020

kmax12 commented Apr 15, 2020

dsherry commented Apr 15, 2020

dsherry Apr 15, 2020

dsherry Apr 15, 2020

dsherry commented Apr 15, 2020 •

edited

Loading

dsherry commented Apr 28, 2020

Changelog checkin test: succeed for release PRs #658

Changelog checkin test: succeed for release PRs #658

Conversation

dsherry commented Apr 15, 2020 • edited Loading

codecov bot commented Apr 15, 2020 • edited Loading

Codecov Report

dsherry commented Apr 15, 2020

jeremyliweishih left a comment

Choose a reason for hiding this comment

jeremyliweishih Apr 15, 2020

Choose a reason for hiding this comment

dsherry Apr 15, 2020

Choose a reason for hiding this comment

jeremyliweishih Apr 15, 2020

Choose a reason for hiding this comment

angela97lin left a comment

Choose a reason for hiding this comment

angela97lin Apr 15, 2020

Choose a reason for hiding this comment

dsherry Apr 15, 2020

Choose a reason for hiding this comment

kmax12 commented Apr 15, 2020

dsherry commented Apr 15, 2020

dsherry Apr 15, 2020

Choose a reason for hiding this comment

dsherry Apr 15, 2020

Choose a reason for hiding this comment

dsherry commented Apr 15, 2020 • edited Loading

dsherry commented Apr 28, 2020

dsherry commented Apr 15, 2020 •

edited

Loading

codecov bot commented Apr 15, 2020 •

edited

Loading

dsherry commented Apr 15, 2020 •

edited

Loading