Make backporting action use PRs to support protected branches [DOC-268] #1396
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In [DOC-255](https://hazelcast.atlassian.net/browse/DOC-255), branch protection was added - preventing direct `push`es. Instead, the backport workflow should create PRs to backport the changes. This gives the _possibility_ for pre-merge checks to be run (i.e. preventing introducing dead links etc). Leverages [_existing_ `backport` tool](https://github.com/hazelcast/backport), but exposed some issues which need to be addressed *before this can be merged*: - T - B - C Tested in a [test repo](https://github.com/JackPGreen2/hz-docs), where a [dummy PR](JackPGreen2#5) was [successfully backported](JackPGreen2#16). However, due to the complexity of fork-triggering, it wil need to be re-tested once merged. Fixes: [DOC-268](https://hazelcast.atlassian.net/browse/DOC-268)
✅ Deploy Preview for hardcore-allen-f5257d ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
nishaatr
requested changes
Nov 25, 2024
nishaatr
approved these changes
Nov 27, 2024
JackPGreen
added a commit
to hazelcast/backport
that referenced
this pull request
Nov 27, 2024
To support `backport` being used in multiple GitHub Actions: - hazelcast/hazelcast-mono#3642 - hazelcast/hz-docs#1396 A composite GitHub Action has been created to centralise it's usage, to make callers simpler. Implementation is a sliced from `hazelcast-mono`, with some parameters now explicit inputs. Tested via [dummy PR](JackPGreen2/hz-docs#14) in [test repo](https://github.com/JackPGreen2/hz-docs) that [backported successfully](https://github.com/JackPGreen2/hz-docs/actions/runs/12029584772/job/33536129458) (via JackPGreen2/hz-docs#26).
|
@hazelcast/documentation is anyone able to review, please? |
fantkolja
approved these changes
Dec 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In DOC-255, branch protection was added - preventing direct
pushes.Instead, the backport workflow should create PRs to backport the changes. This gives the possibility for pre-merge checks to be run (i.e. preventing introducing dead links etc).
Leverages existing
backporttool, but exposed some issues which need to be addressed before this can be merged:/in name [DOC-268] backport#14omit-labelsfunctionality [DOC-268] backport#15backportworkflow backport#17Tested in a test repo, where a dummy PR was successfully backported. However, due to the complexity of fork-triggering, it wil need to be re-tested once merged.
Fixes: DOC-268