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

ci(release): improved input descriptions #11304

Merged
1 commit merged into from
Dec 21, 2022
Merged

ci(release): improved input descriptions #11304

1 commit merged into from
Dec 21, 2022

Conversation

megglos
Copy link
Contributor

@megglos megglos commented Dec 20, 2022

Description

Improved descriptions for the Release job inputs as well as revised order and defaults (e.g. letting dryRun to default to false now, as from a release managers perspective that is the desired value). In order to make the ease of use better.

I prefixed all input descriptions with the name of the input itself, this helped to easier refer to inputs e.g. from the instructions within the release process forms.

Related issues

closes #11303

@megglos megglos requested a review from Zelldon December 20, 2022 13:27
@github-actions
Copy link
Contributor

github-actions bot commented Dec 20, 2022

Test Results

   966 files  ±    0     966 suites  ±0   1h 45m 43s ⏱️ + 1m 54s
7 729 tests +144  7 722 ✔️ +144  7 💤 ±0  0 ±0 
7 937 runs  +144  7 928 ✔️ +144  9 💤 ±0  0 ±0 

Results for commit ee58cdd. ± Comparison against base commit 565efaf.

♻️ This comment has been updated with latest results.

Copy link
Member

@Zelldon Zelldon left a comment

Choose a reason for hiding this comment

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

Hey @megglos

thanks for improving the UX. I was thinking how it would look like and checked the result

screenshot

I felt a bit overwhelm by the text. Maybe we can reorder the fields to have all required on the top and all optional afterward. Plus the optional/required as prefix would (I think) be more helpful. Wdyt?

But I'm also fine with this you can decide.

@megglos megglos force-pushed the meg-release-ux-improvement branch 2 times, most recently from d59e05c to 4947ea1 Compare December 21, 2022 12:46
@megglos
Copy link
Contributor Author

megglos commented Dec 21, 2022

I felt a bit overwhelm by the text. Maybe we can reorder the fields to have all required on the top and all optional afterward. Plus the optional/required as prefix would (I think) be more helpful. Wdyt?

But I'm also fine with this you can decide.
👍

reduced it to:

image

@megglos
Copy link
Contributor Author

megglos commented Dec 21, 2022

bors r+

@ghost
Copy link

ghost commented Dec 21, 2022

Build succeeded:

@ghost ghost merged commit c7d4815 into main Dec 21, 2022
@ghost ghost deleted the meg-release-ux-improvement branch December 21, 2022 13:06
@backport-action
Copy link
Collaborator

Backport failed for stable/8.0, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally.

git fetch origin stable/8.0
git worktree add -d .worktree/backport-11304-to-stable/8.0 origin/stable/8.0
cd .worktree/backport-11304-to-stable/8.0
git checkout -b backport-11304-to-stable/8.0
ancref=$(git merge-base 565efaf891a5ac6fe0f6271fdb0c726d3080463d ee58cdd7a84c5903ce3b291cb4dc001db55faad6)
git cherry-pick -x $ancref..ee58cdd7a84c5903ce3b291cb4dc001db55faad6

@backport-action
Copy link
Collaborator

Backport failed for stable/8.1, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally.

git fetch origin stable/8.1
git worktree add -d .worktree/backport-11304-to-stable/8.1 origin/stable/8.1
cd .worktree/backport-11304-to-stable/8.1
git checkout -b backport-11304-to-stable/8.1
ancref=$(git merge-base 565efaf891a5ac6fe0f6271fdb0c726d3080463d ee58cdd7a84c5903ce3b291cb4dc001db55faad6)
git cherry-pick -x $ancref..ee58cdd7a84c5903ce3b291cb4dc001db55faad6

ghost pushed a commit that referenced this pull request Dec 21, 2022
11321: Backport 11304 to stable 8.1 r=megglos a=megglos

## Description
(cherry picked from commit ee58cdd)

Backport of #11304

Co-authored-by: Meggle (Sebastian Bathke) <sebastian.bathke@camunda.com>
ghost pushed a commit that referenced this pull request Dec 21, 2022
11323: Backport 11304 to stable 8.1 r=megglos a=megglos

## Description
(cherry picked from commit ee58cdd)

Backport of #11304

Co-authored-by: Meggle (Sebastian Bathke) <sebastian.bathke@camunda.com>
@Zelldon Zelldon added release/8.0.10 version:8.1.6 Marks an issue as being completely or in parts released in 8.1.6 labels Jan 3, 2023
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
version:8.1.6 Marks an issue as being completely or in parts released in 8.1.6
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adjust release process to use new gha release job
3 participants