Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare for a v1 release #289

Closed
9 tasks done
korthout opened this issue Oct 17, 2022 · 0 comments · Fixed by #306
Closed
9 tasks done

Prepare for a v1 release #289

korthout opened this issue Oct 17, 2022 · 0 comments · Fixed by #306
Assignees

Comments

@korthout
Copy link
Owner

korthout commented Oct 17, 2022

This action has been around for some time now and is actively used by multiple large and very active projects. It has been tested in production for long enough. It's time to remove the This project is still in an early development stage note at the top of the README and release v1 of the backport action.

What should be included in v1?

IMO, a v1 release should come with a major feature or large change to the project. The main feature of the v1 release of the backport action might as well be performance (or energy efficiency). While investigating a performance regression, we researched how to use shallow clones and fetch-depth to optimize the git clone (via actions/checkout), and the git fetches to the bare minimum. These lead to small improvements for small projects and should lead to large improvements for repositories with a long history. This performance improvement is not yet production ready, but we could easily turn it into a release candidate which we can battle-test before releasing v1.

I started this project originally together with @pihme to solve a specific problem for the Zeebe team: to automatically backport pull requests merged with octopus commits. Over time, the action has also found usages outside of Camunda. To improve the visibility, I'd like to publish the action on the GitHub Marketplace. Therefore, I will move this repo under my personal account github.com/korthout. There, I will be able to take more control over the project and work towards releasing it more often.

Checklist

  • clean up the code from korthout-fetch-depth Optimize git fetch-depth #296
  • create a release candidate v1-rc1
  • update the README to announce release candidate and repo ownership move
  • battle test for one month, releasing more candidates if needed, e.g. v1-rc2
  • move repo to personal account after battle testing is completed
  • rename master to main
  • remove the memo from the README
  • release v1, v1.0, and v1.0.0 (switch to full semantic versioning after this)
  • publish to marketplace
zeebe-bors-camunda bot added a commit to camunda/camunda that referenced this issue Nov 24, 2022
11092: Switch to v1-rc1 of backport-action r=korthout a=korthout

## Description

<!-- Please explain the changes you made here. -->
[This pre-release](https://github.com/zeebe-io/backport-action/releases/tag/v1-rc1) has been tested with [korthout/backport-action-test](https://github.com/korthout/backport-action-test), but I'd like to battle-test it in the Zeebe project.

It should provide a considerable performance gain when performing backports. Additionally, it allows us to remove some of the inputs because they are now all optional.

You can read more about this pre-release in:
- korthout/backport-action#289

## Related issues

<!-- Which issues are closed by this PR or are related -->

NA



Co-authored-by: Nico Korthout <nico.korthout@camunda.com>
@korthout korthout self-assigned this Dec 21, 2022
@korthout korthout mentioned this issue Dec 21, 2022
@korthout korthout linked a pull request Dec 21, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant