🎉 New release maker #1

fiendish · 2020-05-18T23:05:23Z

Can't inline it, so I'll just link to the README.md

dankolbman · 2020-05-19T01:49:01Z

.github/workflows/gh_release.yml

+
+jobs:
+  context:
+    if: github.base_ref == 'master' && github.event.pull_request.merged && contains( github.event.pull_request.labels.*.name, 'release')


This requires a new release label? Is that preferable to a regex?

I think it is probably preferable? Keep in mind that the label is added automatically by the user tool, so it's not like there's extra user effort involved.

We could use both to be double extra safe?

I'm open to being convinced against using a label though. I don't have a strong feeling about best practice either way.

Label tag sound good because we currently label all PRs except for releases. We just need to make sure we have a standard release label across all repos.

I like the the label idea! Especially because the user doesn't have to remember to add it since the tool does it

dankolbman · 2020-05-19T01:50:19Z

.github/workflows/gh_release.yml

+# This workflow will install Python dependencies, run pre-release script, and
+# then bundle a github release
+
+name: Release generator


Fancy ⚡
It may be better to publish this as an action that way we can make updates to it without having to have everyone copy all the new files. See GH Docs on that.

That's a good idea. I'll look into it.

Upon reading up about actions/workflows/deployment, I don't think this will be feasible. I called this an action, but really it's a workflow, and a workflow doesn't only encode what happens but also when it happens, which a published action doesn't do, but which is very important for this to work right.

One way to provide centralized reusability could be to use git submodules instead of copying the file around.

dankolbman · 2020-05-19T01:52:21Z

.github/workflows/gh_release.yml

+      - name: Create tag from title and run asset script
+        id: find_tag_and_prepare_assets
+        run: |
+          TAG=$(echo ${{ github.event.pull_request.title }} | sed -E "s/^.*Release (.+\..+\..+)$/\1/g")


Maybe use the official regex? https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string

The PR titles should all be simpler than the full range of valid semver. But we can try it!

The official regex is pretty complex. As written, it breaks sed on macos. :\

Alright, given that the CLI will only generate PRs with the the format 🔖 Release #.#.#, and that all this has to do is pick up the #.#.# part to turn it into a tag, which do you prefer:

# https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string SEMVER="(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?" TAG=$(echo ${{ github.event.pull_request.title }} | perl -pe "s/^.*Release ${SEMVER}\$/\1.\2.\3/g")

or

TAG=$(echo ${{ github.event.pull_request.title }} | sed -E "s/^.*Release (.+\..+\..+)$/\1/g")

or something else?

The only other thing I can think of that doesn't require a specific PR title format would be to have the CLI create a second label #.#.# which this workflow step could use and then delete after its finished?

This might also come in handy for the user provided script in step 8 of What the CLI Does. I'm thinking for most of the repos with Python packages, the user provided script will be used to update the package's __init__.py with the current version. For the kf-model-fhir repo, the user script will also need the version to in order to tag the FHIR model's resources with it.

the user script will also need the version

Done in f4b2119

create a second label #.#.# which this workflow step could use and then delete after its finished

I like that. I'll see if it works and post that change if it does.
The downside is that it will pollute the label list if you use the CLI without using this GH action workflow. Thoughts on that?

Done in f4b2119

I think we're talking about two different user scripts. You're referring to the prepare assets script that gets run after the release and I'm referring to the pre-release script that gets executed in step 8 of release build right before the release branch is pushed up to Github.

Although, now that you mention the environment variable.. Maybe the CLI could write the version to a environment variable (e.g. GH_RELEASE_VERSION, something more specific than TAG) and then the pre-release script can read the version from there if it needs it.

If we can do this, then I'd say let's keep this workflow step (get tag) simple and stick with your first regex to get the version from the PR title?

Both scripts are now passed the version as input. If they want to set environment variables, they can.

dankolbman · 2020-05-19T15:21:42Z

d3b_release_maker/release_maker.py

+        else:
+            return None
+
+    def _next_release_version(self, prev_version, release_type):


May be able to discard this in favor of just using semver's bump_major() style functions.

I'm pretty sure I was using semver's bump functions in this code at some point. I wonder when that got flipped.

znatty22 · 2020-05-20T14:32:11Z

.github/workflows/gh_release.yml

@@ -0,0 +1,59 @@
+# This workflow will install Python dependencies, run pre-release script, and


Suggested change

# This workflow will install Python dependencies, run pre-release script, and

# This workflow will install Python dependencies, run prepare release asset script, and

znatty22 · 2020-05-20T14:33:35Z

github_action/gh_release.yml

@@ -0,0 +1,59 @@
+# This workflow will load Python, run a pre-release script to generate assets,


This file looks like a duplicate of .github/workflows/gh_release.yml?

znatty22 · 2020-05-20T16:00:51Z

.github/workflows/gh_release.yml

+      - name: Create tag from title and run asset script
+        id: find_tag_and_prepare_assets
+        run: |
+          TAG=$(echo ${{ github.event.pull_request.title }} | sed -E "s/^.*Release (.+\..+\..+)$/\1/g")


The only other thing I can think of that doesn't require a specific PR title format would be to have the CLI create a second label #.#.# which this workflow step could use and then delete after its finished?

This might also come in handy for the user provided script in step 8 of What the CLI Does. I'm thinking for most of the repos with Python packages, the user provided script will be used to update the package's __init__.py with the current version. For the kf-model-fhir repo, the user script will also need the version to in order to tag the FHIR model's resources with it.

znatty22 · 2020-05-20T16:14:48Z

d3b_release_maker/release_maker.py

+            os.system(pre_release_script)
+
+        # Create and push new release branch
+        release_branch_name = f"🔖-release-{new_version}"


Whaaaat can git branch names have emojis 🙃?

znatty22 · 2020-05-20T16:19:24Z

d3b_release_maker/release_maker.py

+        if pre_release_script:
+            print(f"Executing pre-release script {pre_release_script} ...")
+            os.chmod(pre_release_script, "u+x")
+            os.system(pre_release_script)


Will os.system raise an exception if something goes wrong? If not, maybe use subprocess? Whatever we use, as long as make_release fails if the pre-release script fails

I guess I have the same comment for the other os.system calls too. If they fail, will an exception be raised or will this script keep executing?

ok e39398f

znatty22

This is really cool! I tried it on one of my temp repos and it works really well. Just have one minor comment

znatty22 · 2020-05-21T21:39:05Z

d3b_release_maker/release_maker.py

+
+        if pre_release_script:
+            print(f"Executing pre-release script {pre_release_script} ...")
+            os.chmod(pre_release_script, "u+x")


Looks like os.chmod only takes the numeric form of the permission: https://docs.python.org/3.7/library/os.html#os.chmod

And it looks annoying bc you need to import stat

Maybe we should just require the user to make sure their script is executable? Same for the prepare_assets.sh script

Grumble!

At least prepare_assets is called from bash, so hopefully that'll be ok

fiendish · 2020-05-22T15:41:54Z

rebased and squashed after latest changes

znatty22

Looks good! Are you going to 🔖 it?!

fiendish · 2020-06-01T14:21:19Z

🤔 hmm

I'm not sure that the symlink will work. But we can try!

fiendish · 2020-06-01T14:22:46Z

Actually, I'll test that on a fake repo first.

fiendish · 2020-06-01T14:29:06Z

Yeah. GH doesn't treat the symlink as a symlink, so I have to remove it. :(

I also sent GH a feature request to support symlinks in the workflows directory.

znatty22

I couldn't comment on the file itself, so I'll put the comment here. If you put a version variable in your __init__.py and import it in setup.py to set the version arg, it might be easier to write a pre_release.sh script that just updates __init__.py with the new version during the release process. Then when you release this, you won't have to do it manually.

fiendish · 2020-06-01T16:43:03Z

I couldn't comment on the file itself, so I'll put the comment here. If you put a version variable in your __init__.py and import it in setup.py to set the version arg, it might be easier to write a pre_release.sh script that just updates __init__.py with the new version during the release process. Then when you release this, you won't have to do it manually.

What about this instead? It automatically pulls the package version from the git tag. d07ecec

znatty22

👍

## Release 1.0.0 ### Summary - Emojis: 👷 x1, 🎉 x1 - Categories: Ops x1, Additions x1 ### New features and changes - [#2](#2) - 👷 Lint PRs - [a5bd6cc](a5bd6cc) by [fiendish](https://github.com/fiendish) - [#1](#1) - 🎉 New release maker - [1c49d0a](1c49d0a) by [fiendish](https://github.com/fiendish)

fiendish requested a review from znatty22 May 18, 2020 23:05

fiendish force-pushed the release-maker branch from aec5ef6 to d73fe04 Compare May 18, 2020 23:06

fiendish requested review from dankolbman and allisonheath May 18, 2020 23:06

fiendish force-pushed the release-maker branch 5 times, most recently from bf39fc5 to 485eb78 Compare May 19, 2020 14:24

dankolbman reviewed May 19, 2020

View reviewed changes

znatty22 requested changes May 20, 2020

View reviewed changes

fiendish force-pushed the release-maker branch from 2991ca4 to 834e528 Compare May 20, 2020 19:25

fiendish requested review from znatty22 and dankolbman May 20, 2020 19:32

znatty22 requested changes May 21, 2020

View reviewed changes

fiendish force-pushed the release-maker branch from 3518cfb to 4510ddb Compare May 22, 2020 15:19

🎉 New release maker CLI

fb298bc

fiendish force-pushed the release-maker branch from 3fc9f21 to aee9119 Compare May 22, 2020 15:41

fiendish requested a review from znatty22 May 22, 2020 15:42

znatty22 previously approved these changes May 24, 2020

View reviewed changes

✨ Autoreleasing GH Action

e601b83

fiendish dismissed znatty22’s stale review via e42966c June 1, 2020 14:31

fiendish force-pushed the release-maker branch from aee9119 to e42966c Compare June 1, 2020 14:31

fiendish requested a review from znatty22 June 1, 2020 14:31

📝 Populate readme

6004da9

fiendish force-pushed the release-maker branch from e42966c to 6004da9 Compare June 1, 2020 14:49

znatty22 reviewed Jun 1, 2020

View reviewed changes

🔧 Use scm tag for python package version

d07ecec

fiendish requested a review from znatty22 June 1, 2020 16:49

znatty22 approved these changes Jun 2, 2020

View reviewed changes

fiendish merged commit 1c49d0a into master Jun 2, 2020

fiendish deleted the release-maker branch June 2, 2020 15:44

fiendish mentioned this pull request Jun 3, 2020

🔖 Release 1.0.0 #3

Merged

		@@ -0,0 +1,59 @@
		# This workflow will install Python dependencies, run pre-release script, and

		@@ -0,0 +1,59 @@
		# This workflow will load Python, run a pre-release script to generate assets,

🎉 New release maker #1

🎉 New release maker #1

Conversation

fiendish commented May 18, 2020 • edited

Choose a reason for hiding this comment

fiendish May 19, 2020 • edited

Choose a reason for hiding this comment

fiendish May 19, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fiendish May 19, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fiendish May 19, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fiendish May 20, 2020 • edited

Choose a reason for hiding this comment

znatty22 May 20, 2020 • edited

Choose a reason for hiding this comment

fiendish May 20, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fiendish May 19, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fiendish May 20, 2020 • edited

Choose a reason for hiding this comment

znatty22 May 20, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

znatty22 left a comment

Choose a reason for hiding this comment

znatty22 May 21, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fiendish May 22, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fiendish commented May 22, 2020 • edited

znatty22 left a comment

Choose a reason for hiding this comment

fiendish commented Jun 1, 2020 • edited

fiendish commented Jun 1, 2020

fiendish commented Jun 1, 2020 • edited

znatty22 left a comment • edited

Choose a reason for hiding this comment

fiendish commented Jun 1, 2020

znatty22 left a comment

Choose a reason for hiding this comment

fiendish commented May 18, 2020 •

edited

fiendish May 19, 2020 •

edited

fiendish May 19, 2020 •

edited

fiendish May 19, 2020 •

edited

fiendish May 19, 2020 •

edited

fiendish May 20, 2020 •

edited

znatty22 May 20, 2020 •

edited

fiendish May 20, 2020 •

edited

fiendish May 19, 2020 •

edited

fiendish May 20, 2020 •

edited

znatty22 May 20, 2020 •

edited

znatty22 May 21, 2020 •

edited

fiendish May 22, 2020 •

edited

fiendish commented May 22, 2020 •

edited

fiendish commented Jun 1, 2020 •

edited

fiendish commented Jun 1, 2020 •

edited

znatty22 left a comment •

edited