Auto-increment next development iteration. #1816

dblock · 2021-12-28T18:20:42Z

Description

Adds a workflow that increments the version of OpenSearch whenever a new X.Y.Z tag is pushed.

To test this I pushed a 1.2.4 tag to my branch, git tag -d 1.2.4 ; git tag 1.2.4 ; git push origin :1.2.4 ; git push origin --tags. That's what would happen if we were to release 1.2.4 tomorrow.

Successful run: https://github.com/dblock/OpenSearch/actions/runs/1631531500
PRs generated:
[AUTO] Incremented version to 1.2.5. dblock/OpenSearch#2
[AUTO] [1.x] Added bwc version 1.2.5. dblock/OpenSearch#3
[AUTO] [main] Added bwc version 1.2.5. dblock/OpenSearch#6

The new workflow produces 3 PRs similar to #1758 and backport PRs into main, and 1.x. It removes the manual steps that start triggering the whole automation to produce the next patch release.

It's possible that this implementation could be done differently/better using gradle, and potentially reused by other components "as is", but I think it's a good enough start because it saves a bunch of manual work.

Issues Resolved

Part of opensearch-project/opensearch-build#1375.

Check List

Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

opensearch-ci-bot · 2021-12-28T18:22:03Z

Can one of the admins verify this patch?

Signed-off-by: dblock <[email protected]>

opensearch-ci-bot · 2021-12-28T19:02:40Z

✅ Gradle Check success fea263e
Log 1697

Reports 1697

Signed-off-by: dblock <[email protected]>

opensearch-ci-bot · 2021-12-28T19:31:18Z

✅ Gradle Check success 90bb9d61278e5ceecde7ee26bc6d82ffa89f27cd
Log 1698

Reports 1698

opensearch-ci-bot · 2021-12-28T19:32:06Z

✅ Gradle Check success 2a456cce8d1467042fa81ad0bddca8aabeb3ac2a
Log 1699

Reports 1699

opensearch-ci-bot · 2021-12-28T19:43:51Z

✅ Gradle Check success 8b2e0afeb82868d1c4ddebec40fbf6dcb096bd72
Log 1700

Reports 1700

opensearch-ci-bot · 2021-12-28T19:43:52Z

❌ Gradle Check failure 960ef55
Log 1701

Reports 1701

dblock · 2021-12-28T19:49:43Z

Log 1701

#1817

dblock · 2021-12-28T20:00:16Z

start gradle check

opensearch-ci-bot · 2021-12-28T20:47:15Z

✅ Gradle Check success 960ef55
Log 1703

Reports 1703

dblock · 2021-12-28T22:08:09Z

@saratvemulapalli @andrross could i get a CR on this please since we’re not done making log4j patch releases any time soon …

saratvemulapalli · 2021-12-28T22:31:31Z

.github/workflows/version.yml

+        uses: peter-evans/create-pull-request@v3
+        with:
+          base: ${{ env.BASE }}
+          branch: 'create-pull-request/patch-${{ env.BASE }}'


The bot will have problems creating a branch on OpenSearch as it doesn't have permissions to create one. Only maintainers on OpenSearch can.
This is the similar problem @VachaShah was trying solve for auto-backport workflow.

To quickly test out:

On the fork you could enable branch protection

Try running the workflow

The bot should have to create its own fork to solve this problem or we have to fiddle with the permissions.

Would relaxing branch protection rules to only include actual versioned branches main and *.* work? I don't see why we need to have something so strict. Half of these shouldn't exist anyway.

Yup that should solve it.
AFAIK it was enabled because of a CVE on github. @CEHENKLE might have more details.

On opensearch-build branch protection is only on "root" branches, "*". Can I just change it in this repo?

I believe it was because of https://medium.com/cider-sec/bypassing-required-reviews-using-github-actions-6e1b29135cc7.

I am in line with you to relax branch protection rules only to main and release branches.

peternied

Can we use https://github.com/marketplace/actions/version-increment to handle the version calculation?

dblock · 2022-01-03T23:00:34Z

https://github.com/marketplace/actions/version-increment

I've seen it and I am not sold. It's possible, but we have a lot of different version types to modify to do an actual version increment.

dblock · 2022-01-03T23:03:59Z

@saratvemulapalli I relaxed branch protection to only *.

peternied · 2022-01-04T03:02:38Z

https://github.com/marketplace/actions/version-increment

I've seen it and I am not sold. It's possible, but we have a lot of different version types to modify to do an actual version increment.

Seems like we are going to be doing a lot of copypasta from this POC. Shame we couldn't leverage a library to centralize and validate this effort more easily.

dblock · 2022-01-04T13:33:02Z

https://github.com/marketplace/actions/version-increment

I've seen it and I am not sold. It's possible, but we have a lot of different version types to modify to do an actual version increment.

Seems like we are going to be doing a lot of copypasta from this POC. Shame we couldn't leverage a library to centralize and validate this effort more easily.

I agree, but this one is particularly long because OpenSearch has so many places where it needs code changes on a version increment along with 3 branches. Theoretically we can author a common GHA that extracts and increments the version (or use a thirdparty one as suggested), then find a more data-driven mechanism to apply changes like a patch. Open to suggestions towards that, but I also think automated > manual so even if this is pretty messy it's well self-contained in 1 GHA.

.github/workflows/version.yml

saratvemulapalli · 2022-01-04T19:29:45Z

.github/workflows/version.yml

+          base: main
+          branch: 'create-pull-request/patch-main'
+          commit-message: Added bwc version ${{ env.NEXT_VERSION }}
+          delete-branch: true


@VachaShah you could use this for auto-backport workflow.
This should solve the problem of stale branches after the PR is merged.

Thanks @saratvemulapalli ! I just created a PR to fix the auto-backport workflow.

saratvemulapalli

This is a great start, thanks @dblock !

I wish there was a better than a lot of bash magic, may be gradle.
We can always make it better.

* Auto-increment next development iteration. Signed-off-by: dblock <[email protected]> * Make bwc increments on X.Y and main branches. Signed-off-by: dblock <[email protected]> (cherry picked from commit 7a38109)

* Auto-increment next development iteration. Signed-off-by: dblock <[email protected]> * Make bwc increments on X.Y and main branches. Signed-off-by: dblock <[email protected]>

* Auto-increment next development iteration. Signed-off-by: dblock <[email protected]> * Make bwc increments on X.Y and main branches. Signed-off-by: dblock <[email protected]> Signed-off-by: dblock <[email protected]>

* Auto-increment next development iteration. Signed-off-by: dblock <[email protected]> * Make bwc increments on X.Y and main branches. Signed-off-by: dblock <[email protected]> Signed-off-by: dblock <[email protected]> Co-authored-by: Daniel Doubrovkine (dB.) <[email protected]>

dblock requested a review from a team as a code owner December 28, 2021 18:20

dblock requested review from peternied and saratvemulapalli December 28, 2021 18:21

dblock requested a review from adnapibar December 28, 2021 18:29

dblock mentioned this pull request Dec 28, 2021

Added cookbook to increment versions across all plugins. opensearch-project/opensearch-plugins#119

Merged

1 task

Auto-increment next development iteration.

97ccee9

Signed-off-by: dblock <[email protected]>

dblock force-pushed the auto-increment-version branch 3 times, most recently from 2a456cc to 8b2e0af Compare December 28, 2021 18:57

dblock requested a review from andrross December 28, 2021 19:01

Make bwc increments on X.Y and main branches.

960ef55

Signed-off-by: dblock <[email protected]>

dblock force-pushed the auto-increment-version branch from 8b2e0af to 960ef55 Compare December 28, 2021 19:07

dblock mentioned this pull request Dec 28, 2021

[BUG] :rest-api-spec:yamlRestTest org.opensearch.test.rest.ClientYamlTestSuiteIT intermittent failure #1817

Closed

saratvemulapalli reviewed Dec 28, 2021

View reviewed changes

peternied reviewed Jan 3, 2022

View reviewed changes

peternied approved these changes Jan 4, 2022

View reviewed changes

andrross reviewed Jan 4, 2022

View reviewed changes

.github/workflows/version.yml Show resolved Hide resolved

saratvemulapalli reviewed Jan 4, 2022

View reviewed changes

andrross approved these changes Jan 4, 2022

View reviewed changes

saratvemulapalli approved these changes Jan 4, 2022

View reviewed changes

VachaShah mentioned this pull request Jan 4, 2022

Fixing auto backport workflow #1845

Merged

1 task

dblock merged commit 7a38109 into opensearch-project:main Jan 5, 2022

dblock deleted the auto-increment-version branch January 5, 2022 13:15

dblock mentioned this pull request Jan 31, 2022

[BUG] Version increment workflow was not triggered #2013

Open

VachaShah added the backport 1.x label Feb 18, 2022

opensearch-trigger-bot bot mentioned this pull request Feb 18, 2022

[Backport 1.x] Auto-increment next development iteration. #2164

Merged

VachaShah mentioned this pull request Mar 2, 2022

Auto-increment next development iteration. (#1816) #2306

Closed

1 task

tlfeng mentioned this pull request May 6, 2022

[BUG] 'Increment Version' workflow doesn't add new 1.x BWC Version for 2.0 and 2.x branches #3218

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Auto-increment next development iteration. #1816

Auto-increment next development iteration. #1816

dblock commented Dec 28, 2021 •

edited

Loading

opensearch-ci-bot commented Dec 28, 2021

opensearch-ci-bot commented Dec 28, 2021

opensearch-ci-bot commented Dec 28, 2021

opensearch-ci-bot commented Dec 28, 2021

opensearch-ci-bot commented Dec 28, 2021

opensearch-ci-bot commented Dec 28, 2021

dblock commented Dec 28, 2021

dblock commented Dec 28, 2021

opensearch-ci-bot commented Dec 28, 2021

dblock commented Dec 28, 2021

saratvemulapalli Dec 28, 2021 •

edited

Loading

dblock Dec 28, 2021 •

edited

Loading

saratvemulapalli Dec 28, 2021

dblock Dec 29, 2021

saratvemulapalli Dec 29, 2021

peternied left a comment

dblock commented Jan 3, 2022 •

edited

Loading

dblock commented Jan 3, 2022

peternied commented Jan 4, 2022

dblock commented Jan 4, 2022

saratvemulapalli Jan 4, 2022

VachaShah Jan 4, 2022

saratvemulapalli left a comment

Auto-increment next development iteration. #1816

Auto-increment next development iteration. #1816

Conversation

dblock commented Dec 28, 2021 • edited Loading

Description

Issues Resolved

Check List

opensearch-ci-bot commented Dec 28, 2021

opensearch-ci-bot commented Dec 28, 2021

opensearch-ci-bot commented Dec 28, 2021

opensearch-ci-bot commented Dec 28, 2021

opensearch-ci-bot commented Dec 28, 2021

opensearch-ci-bot commented Dec 28, 2021

dblock commented Dec 28, 2021

dblock commented Dec 28, 2021

opensearch-ci-bot commented Dec 28, 2021

dblock commented Dec 28, 2021

saratvemulapalli Dec 28, 2021 • edited Loading

Choose a reason for hiding this comment

dblock Dec 28, 2021 • edited Loading

Choose a reason for hiding this comment

saratvemulapalli Dec 28, 2021

Choose a reason for hiding this comment

dblock Dec 29, 2021

Choose a reason for hiding this comment

saratvemulapalli Dec 29, 2021

Choose a reason for hiding this comment

peternied left a comment

Choose a reason for hiding this comment

dblock commented Jan 3, 2022 • edited Loading

dblock commented Jan 3, 2022

peternied commented Jan 4, 2022

dblock commented Jan 4, 2022

saratvemulapalli Jan 4, 2022

Choose a reason for hiding this comment

VachaShah Jan 4, 2022

Choose a reason for hiding this comment

saratvemulapalli left a comment

Choose a reason for hiding this comment

dblock commented Dec 28, 2021 •

edited

Loading

saratvemulapalli Dec 28, 2021 •

edited

Loading

dblock Dec 28, 2021 •

edited

Loading

dblock commented Jan 3, 2022 •

edited

Loading