Override calculated version, tag and name with input

[pdcmoreira]

Allow overriding the resulting version, tag and name throught input options.
This is useful for workflows scoped by branches (#359) that need to transition a version from one branch to another - GitFlow, for example.

[TimonVS]

Thanks for the PR @pdcmoreira. This is an awesome addition. I'm going to give it a test run!

[TimonVS]

Tested it for a bit. The functionality is great, I have a few suggestions for improvements :)

[pdcmoreira]

Rebased onto master and separated the manual input version from the calculated ones.
@TimonVS Please check if that's what you had in mind.

[pdcmoreira]

Rebased onto master and fixed a bug with the mocked env that was leaking into other tests.

[jetersen]

LGTM

[pdcmoreira]

Rebased onto master.
By having the input version and the calculated version separated, I noticed that there was no way to create a generic template that would print the input version if available or the calculated one otherwise, so I've added a new $RESOLVED_VERSION variable that does just that.

[TimonVS]

$RESOLVED_VERSION is a great addition @pdcmoreira! I'm testing it one last time and then I'll merge and release it.

[TimonVS]

After testing this I noticed that this only works for newly created drafts. I think we should also propagate this through draft updates. This is technically a breaking change, but I would consider it a bug if we don't update the draft, so I think a minor version in this case would still be fine.

[TimonVS]

@pdcmoreira @Casz what do you think about propagating the release's name and tag changes in draft updates too? As mentioned in my previous comment, it's technically a breaking change, but I think it can be considered a bug fix because currently the release name and tag for draft releases won't update even though the input version might have changed. But, people might rely on this functionality to update the title or tag of a release manually without having Release Drafter override it with a draft update. What are your thoughts on this?

I have a reproduction for this issue here: https://github.com/TimonVS/rd-override-version. You can test this by having Release Drafter generate a draft first and then change the input version here: https://github.com/TimonVS/rd-override-version/blob/master/.github/workflows/release-drafter.yml#L16. You'll see that the version in the body is updated but that the version in the title and tag stay the same.

@pdcmoreira I rebased your PR btw so that I could test with the latest changes.

[jetersen]

I honestly thought it was a bug but not one I cared to report 🐛😅 Yes I think it is a bug.

[pdcmoreira]

True, I think it should be considered a bug, because if the calculated version changes, it stops being semver compliant.
But it's also true that it might stop fitting some use cases.
My suggestion would be to "fix" the "bug" and add an option to ignore version re-calculation on draft updates.

[TimonVS]

Thanks for your input! I'll create a fix for it, once that's done we'll release this. I've temporarily removed the documentation in this PR so that I can merge it now without having incorrect documentation on the master branch.

[jetersen]

@pdcmoreira I had issues with failing tests due to mockedEnv on my Windows box.
Seems to be related only to the INPUT_CONFIG-NAME mockedEnv 😓

23:01:54.379Z  WARN probot: toolmantim/release-drafter-test-project: Invalid config file
  HttpError: request to https://api.github.com/repos/toolmantim/release-drafter-test-project/contents/.github/config-name-input.yml failed, reason: Nock: No match for request {
    "method": "GET",
    "url": "https://api.github.com/repos/toolmantim/release-drafter-test-project/contents/.github/config-name-input.yml",
    "headers": {
      "accept": [
        "application/vnd.github.v3+json"
      ],
      "user-agent": [
        "octokit.js/16.43.1 Node.js/14.2.0 (Windows 10; x64)"
      ],
      "authorization": [
        "token test"
      ],
      "accept-encoding": [
        "gzip,deflate"
      ],
      "connection": [
        "close"
      ]
    }
  }

[jetersen]

The mockedEnv issue disappeared.