fix: include merged tags when determining the previous release

[MantisClone]

Towards #1442

Problem

The next-release workflow in CircleCI releases a -next package in NPM. It determines the version number based on the previous annotated, tagged commit originating from the master branch. It doesn't consider tags that were merged from other branches.

In #1381 (comment), I force-pushed several annotated tags in an attempt to fix the auto-generated CHANGELOG.md files. Before this, there were zero annotated, tagged commits originating from the master branch so the next-release workflow would fallback to counting commits from the beginning fo time. This is why the -next releases end with a number instead of a commit hash.

The reason there was zero annotated, tagged commits originating from the master branch is that we've always used squash merge to merge PRs into master. squash merge changes the commit hash, thus orphaning the tags produced by lerna publish.

Proposed Solution

1. We could use --include-merged-commits option in the next-release workflow. We could adopt the release process in https://github.com/RequestNetwork/release-tools/pull/8 which uses lerna publish on a release branch and then merges (not squash merge) the tagged commits to master. The -next releases going forward would have shortSHA postfixes instead of refCount postfixes. This requires us to enable merge on the master branch which I don't love - because it runs the risk that non-conventional commits are merged to the master branch.

Alternative Solution

2. We could delete the annotated tags on the master branch. We could still adopt the new release process in https://github.com/RequestNetwork/release-tools/pull/8 except continue using squash merge for the release branch. The -next releases going forward would still have the refCount postfixes, and we wouldn't have to enable merge on the master branch. I don't love this option either because it eliminates the possibility of bumping the version on only changed packages instead of force-publishing all packages every time.

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[MantisClone]

We must go with option 2, cause I already messed it up and merged instead of squashing a normal PR. 🤦

[MantisClone]

I'm closing this because this would change the -next releases to have a shortSHA postfix instead of the refCount

[MantisClone]

The automatic next-release workflow just ran and released a correctly versioned -next release ✅
The fix was to delete the old tags I tampered with. 🫣
This fixed it because these were the only annotated git tags that originated from the master branch rather than a merged branch.