search

rybak / intellij-copy-commit-reference

Plugin for context menu action "Copy Commit Reference" in IDEs from JetBrains.
https://plugins.jetbrains.com/plugin/22138-copy-commit-reference
MIT License
1 stars 0 forks source link

Document release process #5

Open rybak opened 1 year ago

rybak commented 1 year ago

How creation of release draft works and creation of a GitHub release release works isn't obvious. I should document it.

Template's README has some of the details: https://github.com/JetBrains/intellij-platform-plugin-template#continuous-integration

rybak commented 1 year ago

Draft

  1. Update pluginVersion in gradle.properties.
    • Sometimes the change is done before any commit for the release is ready (Maven style). Sometimes, it is created just before the release.
    • Examples:
      • d5935f04385e313a304fdd73258fd7c7901bc3e4
      • 545da2730ead98b1e475eb7888d3f2a31a2ee48a
  2. Push to GitHub the pluginVersion change and anything else that needs to be released
  3. Wait for workflow "Build" to finish
  4. Open the release draft created by the "Release Draft" step of the workflow
    • it is at the top of Releases
    • it is available in the build log of "Release Draft" step of workflow "Build"
  5. Check the changelog in the draft
    • Fix typos in CHANGELOG.md, if any, and go back to step 2
  6. Click button "Publish release"
  7. Wait for workflow "Release" to finish
    • Workflow "Release" creates a changelog PR (example: #6) and a tag (example: v1.1.1)
  8. Check that the plugin got uploaded to the Marketplace
  9. Fetch changelog PR locally – should be at the top of the PR list
  10. Fast-forward merge changelog PR into the release branch (main)
  11. Delete changelog branch
  12. Mark GitHub Notifications for all of the above as "Done"