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

Add omit-labels functionality [DOC-268] #15

Merged
merged 3 commits into from
Nov 27, 2024

Conversation

JackPGreen
Copy link
Contributor

@JackPGreen JackPGreen commented Nov 22, 2024

When backports are triggered via PR labels, copying the labels to the backport PRs can cause an unexpected cascade.

E.G.:

  • a PR is labelled to backport to multiple branches
  • an action performs these actions in parallel
  • the backported, labelled PRs are detected
  • more backporting is performed
  • etc

Instead it would be easier to optionally omit copying labels to backported PRs.

Fixes: DOC-268

When backports are triggered via PR labels, copying the labels to the backport PRs can cause an unexpected cascade.

E.G.:
- a PR is labelled to backport to multiple branches
- an action performs these actions _in parallel_
- the backported, labelled PRs are detected
- more backporting is performed
- etc

Instead it would be easier to _optionally_ omit copying labels to backported PRs.

Fixes: [DOC-268](https://hazelcast.atlassian.net/browse/DOC-268)
Copy link
Collaborator

@ldziedziul ldziedziul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want to omit labels completely when the backport is triggered by the label?

@JackPGreen
Copy link
Contributor Author

Do you want to omit labels completely when the backport is triggered by the label?

I don’t think I can detect that - in hz-docs it’s triggered by a push containing a specified label.

@ldziedziul
Copy link
Collaborator

I mean what's your plan for fixing this issue on the workflow side?

@JackPGreen
Copy link
Contributor Author

I mean what's your plan for fixing this issue on the workflow side?

I don't have one. You can see my idea here. Ideas welcomed.

@ldziedziul
Copy link
Collaborator

ldziedziul commented Nov 22, 2024

I mean what's your plan for fixing this issue on the workflow side?

I don't have one. You can see my idea here. Ideas welcomed.

Sorry, I can't see where's the loop? The workflow is triggered by workflow_call so labels won't trigger it

@JackPGreen
Copy link
Contributor Author

I mean what's your plan for fixing this issue on the workflow side?

I don't have one. You can see my idea here. Ideas welcomed.

Sorry, I can't see where's the loop? The workflow is triggered by workflow_call so labels won't trigger it

There's an inverse action that forwardports commits to main, calling the same workflow.

Even if it's not possible today, labels aren't really used in hz-docs and I'm happy to skip them to avoid the risk.

@JackPGreen JackPGreen merged commit 013f934 into hazelcast:master Nov 27, 2024
3 checks passed
JackPGreen added a commit to hazelcast/hz-docs that referenced this pull request Dec 2, 2024
…8] (#1396)

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**:
- hazelcast/backport#14
- hazelcast/backport#15
- hazelcast/backport#16
- hazelcast/backport#17

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)

[DOC-255]:
https://hazelcast.atlassian.net/browse/DOC-255?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[DOC-268]:
https://hazelcast.atlassian.net/browse/DOC-268?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
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 this pull request may close these issues.

2 participants