feat(version): Create Github releases with `--github-release` #1864

milesj · 2019-01-10T00:23:17Z

Would solve #1513

Description

This is a proof of concept so I'm looking for feedback. Is this something we want in Lerna? Would it be better as a future type of plugin? etc.

A bulk of the work already exists through conventional-commits + changelog generation. I updated the changelog logic to also return the new entry to use in the body of the GH release. I then wrapped everything in a --github command line option for opt-in purposes.

Other notes:

The GitHub client is its own package that requires specific env vars to exist.
I went with --github instead of --release, since the latter is a bit confusing, especially when terms like version and publish are thrown around. Furthermore, using --github permits additional features in the future, like adding labels to PRs.
It would be nice to use lerna-changelog but the APIs aren't very compatible.

Motivation and Context

I've been looking into using Lerna for auto-releases as a replacement for semantic-release (since it doesn't handle monorepos). The biggest drawback is the lack of GitHub releases, which most of my team wants, and is a requirement before we can switch over.

How Has This Been Tested?

N/A. I'll add tests if this change is good to move forward.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

evocateur

Looks great so far, let's keep going!

utils/github-client/package.json

utils/github-client/github-client.js

evocateur · 2019-01-10T21:03:13Z

core/conventional-commits/lib/update-changelog.js

+        return {
+          logPath: changelogFileLoc,
+          newEntry,
+        };


This is brilliant!

commands/version/index.js

milesj · 2019-01-11T18:55:01Z

@evocateur Awesome to move forward on this! Made some adjustments based on feedback. I'll add tests once the implementation is done.

evocateur

So far so good!

commands/version/index.js

evocateur · 2019-01-11T19:23:40Z

utils/github-client/github-client.js

+  }
+
+  if (GHE_API_URL) {
+    options.baseUrl = GHE_API_URL;


Much clearer, thanks!

commands/version/lib/git-repo-url.js

commands/version/index.js

commands/version/command.js

milesj · 2019-01-16T19:36:29Z

@evocateur Made changes. I think this is good to start adding tests.

evocateur

Yep, looks great so far!

milesj · 2019-01-24T23:29:39Z

@evocateur I'm trying to write tests for the command but can't seem to get access to the releaseNotes array to verify what's been created. Is that possible at all? Since it's abstracted away around the yargs command runner.

evocateur · 2019-01-25T01:52:34Z

The showCommit assertion pattern in https://github.com/lerna/lerna/blob/master/commands/version/__tests__/version-conventional-commits.test.js isn't sufficient? You might need to modify the mock in commands/__mocks__/@lerna/conventional-commits.js to make it more nuanced.

milesj · 2019-01-25T05:10:51Z

I'll take a look at that, thanks.

sidharthachatterjee · 2019-01-31T12:22:27Z

This looks great! We're looking at generating GitHub releases with change logs at https://github.com/gatsbyjs/gatsby/ and eagerly waiting for this to get in!

Thank you for this @milesj

evocateur · 2019-01-31T19:24:22Z

yep, just waiting for the remainder of the tests, then we're good to go

milesj · 2019-01-31T19:43:56Z

Yeah sorry, been a bit swamped and haven't had a change to dig back into it. Hoping this weekend.

evocateur · 2019-02-01T02:21:31Z

@milesj No worries, I completely understand.

evocateur · 2019-02-07T19:49:24Z

I force-rebased your changes on top of recent work in master, so be sure to git pull before continuing.

milesj · 2019-02-07T21:54:28Z

@evocateur Thanks for the heads up 👍

milesj · 2019-02-07T22:41:03Z

@evocateur Added tests 👍

milesj · 2019-02-07T22:41:27Z

commands/version/__tests__/version-github-release.test.js

+        owner: "lerna",
+        repo: "lerna",
+        tag_name: "v2.0.0",
+        name: "v2.0.0",


Just want to verify this is correct for fixed.

…entional-commits (avoids user error)

evocateur

Thanks for your patience!

evocateur · 2019-02-08T01:40:21Z

Hot damn, it worked great!

milesj · 2019-02-08T03:16:25Z

@evocateur AWW YESS! Thanks for accepting it, this is awesome.

ChrisBAshton · 2019-02-08T08:06:47Z

Amazing work, thanks @milesj !

tunnckoCore · 2019-02-11T11:19:07Z

That's great, but it also generates a CHANGELOG.md. Is it expected or a bug?
When pass --no-changelog, then it does not generate releases too, but in the docs is mentioned that it only requires --conventional-commits.

Or at least, if those files are needed for generating releases, then can we add one more flag to not commit the changelogs after the release is created?

evocateur · 2019-02-11T19:40:36Z

@tunnckoCore Yes, currently it is required to write out the changelog files due to the way the code is currently factored:

lerna/core/conventional-commits/lib/update-changelog.js

Lines 48 to 68 in 45a05ac

    
             // generate the markdown for the upcoming release. 
        
             const changelogStream = conventionalChangelogCore(options, context, gitRawCommitsOpts); 
        
             return Promise.all([ 
        
               getStream(changelogStream).then(makeBumpOnlyFilter(pkg)), 
        
               readExistingChangelog(pkg), 
        
             ]).then(([newEntry, [changelogFileLoc, changelogContents]]) => { 
        
               log.silly(type, "writing new entry: %j", newEntry); 
        
               const content = [CHANGELOG_HEADER, newEntry, changelogContents].join(BLANK_LINE); 
        
               return fs.writeFile(changelogFileLoc, content.trim() + EOL).then(() => { 
        
                 log.verbose(type, "wrote", changelogFileLoc); 
        
                 return { 
        
                   logPath: changelogFileLoc, 
        
                   newEntry, 
        
                 }; 
        
               }); 
        
             }); 
        
           });

The docs aren't wrong, per se, but they are certainly omitting a case. I can add an error when --no-changelog is also passed to make it extra clear.

tunnckoCore · 2019-02-11T20:23:43Z

Yea, warning or directly error sounds good.

evocateur · 2019-02-11T21:50:26Z

030de9d should do the trick.

azz · 2019-03-06T00:22:37Z

Is there a issue to track supporting --no-changelog with --github-release?

evocateur · 2019-03-06T02:38:05Z

Not that I'm aware of, no.

…

On Mar 5, 2019, at 16:22, Lucas Azzola ***@***.***> wrote: Is there a issue to track supporting --no-changelog with --github-release? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

milesj · 2019-03-06T06:45:11Z

@azz Curious how you think that would work?

azz · 2019-03-06T08:51:41Z

I'm not completely across the technical details, but generating both CHANGELOG.md and GitHub releases is duplicate information.

azz · 2019-03-06T08:58:02Z

Raised #1959 to discuss

evocateur added the WIP label Jan 10, 2019

evocateur suggested changes Jan 10, 2019

View reviewed changes

evocateur suggested changes Jan 11, 2019

View reviewed changes

evocateur reviewed Jan 14, 2019

View reviewed changes

commands/version/command.js Outdated Show resolved Hide resolved

evocateur reviewed Jan 17, 2019

View reviewed changes

evocateur added test required and removed WIP labels Jan 17, 2019

evocateur approved these changes Jan 17, 2019

View reviewed changes

evocateur mentioned this pull request Feb 4, 2019

[Feature] Option to automatically 'publish' Releases on GitHub #1513

Closed

milesj and others added 7 commits February 7, 2019 11:12

Update changelog to return the new entry.

eba565b

Add GH client.

4a44141

Add release notes logic to version.

8399b63

Fix readme.

4be128e

More improvements.

f3c38e2

More work.

6d8df65

Add github-client tests.

a7045ec

Add tests.

79d4bd6

milesj commented Feb 7, 2019

View reviewed changes

milesj changed the title ~~WIP: Create GitHub releases when versioning/tagging~~ Create GitHub releases when versioning/tagging Feb 7, 2019

milesj and others added 8 commits February 7, 2019 14:50

Add docs.

bdb5aaf

Remove snapshots.

a9bb128

test(conventional-commits): use inline snapshots, verify newEntry field

5cb2c2b

test(conventional-commits): Refactor command mock usage

8c2ab56

test(version): Add lib mocks for remainder of git operations

6064b57

test(version): simplify github-release tests

8b36500

fix(version): Ensure prerelease field is always Boolean, tweak init

dd25bdb

fix(version): Ensure --github-release is always accompanied by --conv…

2666d63

…entional-commits (avoids user error)

evocateur approved these changes Feb 8, 2019

View reviewed changes

evocateur changed the title ~~Create GitHub releases when versioning/tagging~~ feat(version): Create Github releases with --github-release Feb 8, 2019

evocateur removed the test required label Feb 8, 2019

evocateur merged commit f84a631 into lerna:master Feb 8, 2019

milesj deleted the gh-release branch February 8, 2019 03:16

redallen mentioned this pull request Feb 8, 2019

build(tags): stop lerna from publishing extraneous git tags patternfly/patternfly-react#1348

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(version): Create Github releases with `--github-release` #1864

feat(version): Create Github releases with `--github-release` #1864

milesj commented Jan 10, 2019 •

edited

evocateur left a comment

evocateur Jan 10, 2019

milesj commented Jan 11, 2019

evocateur left a comment

evocateur Jan 11, 2019

milesj commented Jan 16, 2019

evocateur left a comment

milesj commented Jan 24, 2019

evocateur commented Jan 25, 2019

milesj commented Jan 25, 2019

sidharthachatterjee commented Jan 31, 2019

evocateur commented Jan 31, 2019

milesj commented Jan 31, 2019

evocateur commented Feb 1, 2019

evocateur commented Feb 7, 2019

milesj commented Feb 7, 2019

milesj commented Feb 7, 2019

milesj Feb 7, 2019

evocateur left a comment

evocateur commented Feb 8, 2019

milesj commented Feb 8, 2019

ChrisBAshton commented Feb 8, 2019

tunnckoCore commented Feb 11, 2019 •

edited

evocateur commented Feb 11, 2019

tunnckoCore commented Feb 11, 2019

evocateur commented Feb 11, 2019

azz commented Mar 6, 2019

evocateur commented Mar 6, 2019 via email

milesj commented Mar 6, 2019

azz commented Mar 6, 2019

azz commented Mar 6, 2019

feat(version): Create Github releases with --github-release #1864

feat(version): Create Github releases with --github-release #1864

Conversation

milesj commented Jan 10, 2019 • edited

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

evocateur left a comment

Choose a reason for hiding this comment

evocateur Jan 10, 2019

Choose a reason for hiding this comment

milesj commented Jan 11, 2019

evocateur left a comment

Choose a reason for hiding this comment

evocateur Jan 11, 2019

Choose a reason for hiding this comment

milesj commented Jan 16, 2019

evocateur left a comment

Choose a reason for hiding this comment

milesj commented Jan 24, 2019

evocateur commented Jan 25, 2019

milesj commented Jan 25, 2019

sidharthachatterjee commented Jan 31, 2019

evocateur commented Jan 31, 2019

milesj commented Jan 31, 2019

evocateur commented Feb 1, 2019

evocateur commented Feb 7, 2019

milesj commented Feb 7, 2019

milesj commented Feb 7, 2019

milesj Feb 7, 2019

Choose a reason for hiding this comment

evocateur left a comment

Choose a reason for hiding this comment

evocateur commented Feb 8, 2019

milesj commented Feb 8, 2019

ChrisBAshton commented Feb 8, 2019

tunnckoCore commented Feb 11, 2019 • edited

evocateur commented Feb 11, 2019

tunnckoCore commented Feb 11, 2019

evocateur commented Feb 11, 2019

azz commented Mar 6, 2019

evocateur commented Mar 6, 2019 via email

milesj commented Mar 6, 2019

azz commented Mar 6, 2019

azz commented Mar 6, 2019

feat(version): Create Github releases with `--github-release` #1864

feat(version): Create Github releases with `--github-release` #1864

milesj commented Jan 10, 2019 •

edited

tunnckoCore commented Feb 11, 2019 •

edited