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

Improve default success message of step #650

Closed
hohwille opened this issue Sep 24, 2024 · 1 comment · Fixed by #645
Closed

Improve default success message of step #650

hohwille opened this issue Sep 24, 2024 · 1 comment · Fixed by #645
Assignees
Labels
enhancement New feature or request logging step Logging and monitoring of process steps

Comments

@hohwille
Copy link
Member

When a developer creates a new step named «step-name» this will immediately trigger the following log output on loglevel STEP:

Start: «step-name»

The developer can now end the step explicitly with a custom success message but if he just invokes step.success() then a default success message is logged on loglevel STEP.
This is currently just:

«step-name»

Depending on what the developer has chosen as step name this can be rather confusing.
Instead we should get something like this:

Successfully ended step '«step-name»'.
@hohwille hohwille added the enhancement New feature or request label Sep 24, 2024
@hohwille hohwille added this to the release:2024.09.002 milestone Sep 24, 2024
@github-project-automation github-project-automation bot moved this to 🆕 New in IDEasy board Sep 24, 2024
@hohwille hohwille added logging step Logging and monitoring of process steps labels Sep 24, 2024
@hohwille hohwille linked a pull request Sep 24, 2024 that will close this issue
@hohwille
Copy link
Member Author

Example log before change when running ide update:

Start: Install or update software
Start: Install eclipse
Version 2024-09 of tool eclipse is already installed
Install eclipse
Start: Install intellij
Version 2023.3.7 of tool intellij is already installed
Install intellij
Start: Install gradle
Version 8.10.2 of tool gradle is already installed
Install gradle
Start: Install jmc
Version 9.0.0 of tool jmc is already installed
Install jmc
Start: Install npm
Version 10.8.3 of tool npm is already installed
Install npm
Start: Install tomcat
Necessary version of the dependency java is already installed in repository
Version 10.1.30 of tool tomcat is already installed
Install tomcat
Start: Install aws
Trying to download aws-2.17.57-windows-x64.msi from https://awscli.amazonaws.com/AWSCLIV2-2.17.57.msi
Downloading 100% [===============================================] 39/39MiB (0:00:12 / 0:00:00) 3.3MiB/s
Checksum 558afec17ffc15cc2572912b927de4e5420e546d44fbc5f97deb58fd7a711836 is correct.
Successfully installed aws in version 2.17.57 replacing previous version 2.17.56
Start: Install java
Version 21.0.4_7 of tool java is already installed
Install java
Start: Install node
Version v18.20.4 of tool node is already installed
Install node
Start: Install mvn
Version 3.9.9 of tool mvn is already installed
Install mvn
Install or update software

It is not very obvious for the user that Install java means that java is successfully installed.

@hohwille hohwille self-assigned this Sep 24, 2024
@hohwille hohwille moved this from 🆕 New to 🏗 In progress in IDEasy board Sep 24, 2024
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in IDEasy board Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request logging step Logging and monitoring of process steps
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

1 participant