Publish Release Action

[iangmaia]

What does it do?

This PR adds a publish_release action, intended for publishing an already existing GitHub release draft.

Context: in some apps' release process, we first create a prototype to let the release manager to download and test the build prior to the final publishing and store submission. Only when the release is ready to start the rollout, we ask them publish it.
This action will automate this process, finding and publishing the release on GitHub.

Checklist before requesting a review

• Run bundle exec rubocop to test for code style violations and recommendations
• Add Unit Tests (aka specs/*_spec.rb) if applicable
• Run bundle exec rspec to run the whole test suite and ensure all your tests pass
• Make sure you added an entry in the CHANGELOG.md file to describe your changes under the appropriate existing ### subsection of the existing ## Trunk section.
• If applicable, add an entry in the MIGRATION.md file to describe how the changes will affect the migration from the previous major version and what the clients will need to change and consider.

[AliSoftware]

👍 🧹

[AliSoftware]

❓ I'm wondering if we would want to provide a way to keep that value unchanged?

Especially because with this having a default_value and the prerelease being explicitly passed to the API call in the helper, that means that if we ask to publish_release("12.3-rc-2") of a beta GitHub Release draft (which had "This is a pre-release" checkbox checked at the time), without explicitly passing prerelease: true to that call site, this will change the GitHub Release from initially being marked as a pre-release when it was created as Draft to being a final release when published.

Sadly, even if we set to optional: true but with default_value: nil, fastlane will make options[:prerelease] return false (and not nil) if we call the action without the parameter. But I just checked and if we set default_value: :unchanged, then fastlane is happy to have options[:prerelease] return that :unchanged symbol (despite type: Boolean—it doesn't seem to doo any type-check when using the default value). So that means that we could use that to our advantage here, and in self.run do something like:

        url = github_helper.publish_release(
          repository: repository,
          name: name,
          prerelease: (prerelease == :unchanged) ? nil : prerelease
        )

[iangmaia]

Good idea 👍 updated on f9fa87c

[AliSoftware]

If you end up going with my suggestion of supporting :unchanged in the action's parameter, and thus nil for the prerelease parameter of this helper, you might need to call .compact on this hash to remove the potential prerelease: nil value from it when calling the API

[iangmaia]

👍
Updated on f9fa87c

[AliSoftware]

Not sure if it makes more sense to document this in the MIGRATION.md for the upcoming major version (in which it'll still be available… but deprecated), or only mention it in the major version after that, the one in which we'd ultimately delete that backwards-compatibility shim…

I think in the past we went with the latter, but I'm open to debate it if some you think it makes more sense to go with the former 🤔

[iangmaia]

Hmm yeah I think it makes sense to document it there only when the migration is actually needed, so I'd just mention it in the version where we actually remove it, breaking the compatibility 🤔 I think the changelog update should be enough heads up that this is going to change?

[mokagio]

Love it how in Ruby we can pass a symbol as default value and then declare the type as Boolean... 😅

[mokagio]

Have you considered adding a test for the path where GitHub returns an error?

[iangmaia]

@mokagio for the Action level, my first thought was just let the error to propagate in these cases.

[mokagio]

@iangmaia I'll take over merging this already approved PR so that I can update the changelog etc. of my removal PR #580 on top of this.