Release a new build as part of version bump

[dideler]

We can automate a few more steps of the release process when running npm-version:

• Run tests before a new release (using preversion script) - depends on Introduce acceptance tests #9
• Run build as part of version bump (using version script)
• Create an annotated tag with "commit changes" (as a template for GitHub Releases)
  • May need to prevent npm-version from creating a lightweight tag with --no-git-tag-version

Related to #36

[1natsu172]

as a template for GitHub Releases

Specifically, what do we need?

• Annotation tag only?
• Current GitHub release format?

If we want to create GitHub release automatically, may need to write a task to communicate with the REST API with scratch.

• https://developer.github.com/v3/repos/releases/#create-a-release
  • https://github.com/octokit/rest.js

[dideler]

I was hoping we can get the boilerplate text of a release to be more automated, specifically the part

---

Changes: https://github.com/user/repo/compare/old-tag...new-tag

I assumed that with an annotated tag, GitHub Releases would use the tag's message to prepopulate the release. I just tried this and it does prepopulate the release but you lose the message as soon as you "edit tag", which isn't ideal. But we can at least copy the message before hitting the edit button.

For the small gains we get in automation, I don't think it's worth putting in too much effort -- we can probably have something good enough without the need to create a release via GitHub's API.

In the issue description I mentioned the --no-git-tag-version option, but having to type that every time feels cumbersome. Alternatively, we can wrap that option with another script, but that also feels messy because it takes us away from the npm version interface.

Another option is overwriting the lightweight tag with an annotated tag.

  "scripts": {
    ...
    "postversion": "tasks/annotate-tag && git push && git push --tags",
  }

Where tasks/annotate-tag looks something like this

#!/usr/bin/env node

const shell = require('shelljs');
const [old, new] = shell.exec('git tag', {silent: true}).tail({'-n': 2}).stdout.trim().split('\n');

shell.exec(`git tag --annotate --force ${new} ${new}^0 --message "Changes: https://[....]/${old}...${new}"`)

What do you think?

[1natsu172]

---

Changes: https://github.com/user/repo/compare/old-tag...new-tag

I see. If only this part, it seems to be all going well with your method. And I agree to the task of overwriting the lightweight tag with "postversion".

But we can at least copy the message before hitting the edit button.

If we run the task, I think it would be convenient to copy it to the clipboard.

like this 💡

const shell = require('shelljs');

const [oldTag, newTag] = shell.exec('git tag', {silent: true}).tail({'-n': 2}).stdout.trim().split('\n');

const compareText = `Changes: https://github.com/dideler/toggle-youtube-comments/compare/${oldTag}...${newTag}`

shell.exec(`git tag --annotate --force ${new} ${new}^0 --message "${compareText}"`)

shell.exec(`echo ${compareText} | pbcopy`)

[dideler]

If we run the task, I think it would be convenient to copy it to the clipboard.

We'll need to use something cross-platform to copy to clipboard. Here's a couple of libraries

• https://www.npmjs.com/package/clipboardy
• https://www.npmjs.com/package/copy-paste
• https://www.npmjs.com/package/to-clipboard

[1natsu172]

Oh forgot, pbcopy is MacOS only. Certainly need to use one of these modules. 👍

[1natsu172]

Hi @dideler , I submitted a PR on this issue.

It's just an improvement of the development process, so I don't think it's necessary to hurry. Please check it when you have time! 🦄