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

Notify the release manager & slack integration improvements #4650

Merged
merged 5 commits into from
Nov 1, 2024

Conversation

barmac
Copy link
Collaborator

@barmac barmac commented Oct 30, 2024

Proposed Changes

As discussed today in the morning, we want the release manager update to be explicitly notified to the team. This allows to react early in case the new release manager is not available. The PR is aiming to achieve that.

In the boy scout rule spirit, I also unified the slack integration in this repo to use the same version tag of the action, and consistently import the secrets from the vault.

Checklist

To ensure you provided everything we need to look at your PR:

  • Brief textual description of the changes present
  • Visual demo attached
  • Steps to try out present, i.e. using the @bpmn-io/sr tool
  • Related issue linked via Closes {LINK_TO_ISSUE} or Related to {LINK_TO_ISSUE}

@bpmn-io-tasks bpmn-io-tasks bot added the needs review Review pending label Oct 30, 2024
@barmac barmac requested review from a team, philippfromme, jarekdanielak, nikku and misiekhardcore and removed request for a team October 30, 2024 17:19
@nikku
Copy link
Member

nikku commented Oct 30, 2024

@misiekhardcore another good one for you to review.

@nikku nikku removed their request for review October 30, 2024 22:33
Copy link
Contributor

@misiekhardcore misiekhardcore left a comment

Choose a reason for hiding this comment

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

LGTM, just one thing I've noticed not related to functionality - is there any naming convention for workflow job names? cause I see some names with underscores, some with dashes and some in camel case

@barmac
Copy link
Collaborator Author

barmac commented Oct 31, 2024

Looks like there's no convention at time. How would you solve it? Is there any convention endorsed by GH?

@nikku
Copy link
Member

nikku commented Oct 31, 2024

How would you solve it?

I'm a fan of consistency, and would solve it using human readable labels, i.e. "Notify project channel" over "notifcyProjectChannel" or the like. GitHub allows actions to be human readable, and I'd use that.

Our conventions for workflows are that they are UPPERCASE_UNDERSCORED.

@barmac
Copy link
Collaborator Author

barmac commented Oct 31, 2024

For the human-readable label, we can use name property. The job ID cannot have spaces. GH seems to prefer snake_case: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/using-jobs-in-a-workflow#setting-an-id-for-a-job

@barmac
Copy link
Collaborator Author

barmac commented Oct 31, 2024

Proposal:

@barmac
Copy link
Collaborator Author

barmac commented Oct 31, 2024

Proposal:

Implemented in a4b6c14

@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@misiekhardcore
Copy link
Contributor

I personally always try to add name describing the step in human readable form. What about job names themselves I don't have strong preferences as long as they are consistent

Copy link
Member

@nikku nikku left a comment

Choose a reason for hiding this comment

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

Love the unification, let's ensure we communicate with the team and/or check bpmn-js / diagram-js if we have clashes there.

We want to ensure that, as always, the "standard" is clearly visible on the happy path.

@nikku nikku merged commit 4764a5c into develop Nov 1, 2024
11 of 12 checks passed
@bpmn-io-tasks bpmn-io-tasks bot removed the needs review Review pending label Nov 1, 2024
@nikku nikku deleted the notify-the-release-manager branch November 1, 2024 10:46
@nikku
Copy link
Member

nikku commented Nov 1, 2024

Merging this so we can build on top, i.e. with #4655.

@github-actions github-actions bot added this to the M83 milestone Nov 1, 2024
@misiekhardcore
Copy link
Contributor

maybe its a good candidate for a spring cleaning issue to standardize the naming in workflows in other repositories?

@nikku
Copy link
Member

nikku commented Nov 1, 2024

Yes, I'll have a quick look into diagram-js and bpmn-js, just so we have the changes in there.

@misiekhardcore
Copy link
Contributor

I reviewed all of them and left a comment on the names changes

@barmac
Copy link
Collaborator Author

barmac commented Nov 13, 2024

Unfortunately, the automation I built in this PR did not work correctly today: https://github.com/camunda/camunda-modeler/actions/runs/11813602874/job/32910986873
I am investigating.

@barmac
Copy link
Collaborator Author

barmac commented Nov 13, 2024

It looks that the same output was also not handled correctly in another flow: https://github.com/camunda/camunda-modeler/actions/runs/11254745468/job/31292835752

I checked the action logs, and the release_issue seems to never set issue output:

2024-11-13T08:41:41.3945913Z ##[group]Run bpmn-io/actions/release-issue@latest
2024-11-13T08:41:41.3946581Z with:
2024-11-13T08:41:41.3947117Z   template-path: docs/.project/RELEASE_TEMPLATE.md
2024-11-13T08:41:41.3947777Z   package-path: app/package.json
2024-11-13T08:41:41.3948431Z   token: ***
2024-11-13T08:41:41.3948869Z   labels: release,ready
2024-11-13T08:41:41.3949306Z ##[endgroup]
2024-11-13T08:41:44.9624967Z Evaluate and set job outputs
2024-11-13T08:41:44.9636905Z Set output 'assignee'
2024-11-13T08:41:44.9638378Z Cleaning up orphan processes

https://github.com/camunda/camunda-modeler/actions/runs/11813602874/job/32910976873#step:3:2

barmac added a commit to bpmn-io/actions that referenced this pull request Nov 13, 2024
Before the change, the actions can fail silently.
Cf. camunda/camunda-modeler#4650 (comment)
barmac added a commit to bpmn-io/actions that referenced this pull request Nov 13, 2024
Before the change, the actions can fail silently.
Cf. camunda/camunda-modeler#4650 (comment)
barmac added a commit that referenced this pull request Nov 14, 2024
barmac added a commit that referenced this pull request Nov 14, 2024
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.

3 participants