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

Align tool names in scripts #1085

Closed
hohwille opened this issue Mar 28, 2023 · 3 comments · Fixed by #1095 or #1221
Closed

Align tool names in scripts #1085

hohwille opened this issue Mar 28, 2023 · 3 comments · Fixed by #1095 or #1221
Assignees
Labels
enhancement New feature or request

Comments

@hohwille
Copy link
Member

hohwille commented Mar 28, 2023

For epic #941 and as special addition for story #1084 we want to use the migration from mirrors to urls also as cleanup:
In general we follow the best practice and convention that if we have a tool «tool» then we use the same name in the following places:

  • commandlet: scripts/command/«tool»
  • software folder: software/[extra/|macos/]«tool»
  • ide-urls folder: ide-urls/«tool»/«edition»/«version»/
  • variables: «TOOL»_VERSION and «TOOL»_EDITION
  • When running devon «tool» «args» you should get the same effect as when running devon followed by «tool» «args» except that if the tool is not yet installed in the first case it will be downloaded and installed and in the second case it will fail as the tool is not installed.

However, there are currently the following excuses/exceptions to that rule:

  • mvn vs. maven - as the command to run is given as mvn we have to use that instead of maven consistently.
  • node vs. nodejs - as the command to run is given as node we have to use that instead of nodejs consistently.
  • sonar vs. sonarqube - here we do not have any matching given command except StartSonar.bat or the like that is not even in the PATH after set by devon command. For simplicity, I would propose to stay with the shorter name sonar and rename sonarqube occurances to sonar.
  • cobigen vs. cobigen-cli vs. cli. The command is actually cg and cobigen. We can discuss with @jan-vcapgemini but IMHO cobigen is more self explanatory than cg that could confuse new users that might never get what this is about and therefore miss the according features behind it.

The acceptance criteria of this story is that devonfw-ide strictly follows this rules.
Therefore according scripts (see details above) need to be adapted accordingly.
Further we also have to change our devon.properties:

export MAVEN_HOME=${DEVON_IDE_HOME}/software/maven

Please also do a cleanup of internal variables such as COBIGEN_CLI_HOME vs. COBIGEN_HOME, etc.

This story does NOT care about backward compatibility as this is addressed by #1087.

Blocked by dependencies:

@hohwille hohwille added the enhancement New feature or request label Mar 28, 2023
@hohwille hohwille changed the title Align tool names, commands, folders in software and ide-urls Align tool names in scripts Mar 28, 2023
@CREITZ25 CREITZ25 self-assigned this Apr 11, 2023
@CREITZ25
Copy link
Member

CREITZ25 commented Apr 11, 2023

@hohwille
In order to adjust the cobigen commandlet according to the specifications, the path cobigen-cli must be changed to cobigen. The variable COBIGEN_CLI_HOME should also be adjusted to COBIGEN_HOME. However, the problem arises that the variable is already used in the cobigen environment. Therefore, in the scripts/devon.properties file, the variable COBIGEN_HOME is already set to a configuration file or directory. How do I have to proceed here?

https://github.com/devonfw/cobigen/blob/master/documentation/cobigen-core_configuration.asciidoc

@CREITZ25
Copy link
Member

@hohwille after the issue has been implemented, the doGetToolFolderName function is free of the exceptions and generates the name of the software from the transferred software path. Perhaps the function should be renamed to doGetToolName, or replace the calls directly with the contents of the function.

@CREITZ25
Copy link
Member

node is already adapted

CREITZ25 added a commit to CREITZ25/ide that referenced this issue Apr 12, 2023
@CREITZ25 CREITZ25 linked a pull request Apr 12, 2023 that will close this issue
@hohwille hohwille added this to the release:2023.04.001 milestone Apr 13, 2023
CREITZ25 added a commit to CREITZ25/ide that referenced this issue Apr 13, 2023
CREITZ25 added a commit to CREITZ25/ide that referenced this issue Apr 13, 2023
hohwille pushed a commit to devonfw/ide-mirrors that referenced this issue Apr 13, 2023
CREITZ25 added a commit to CREITZ25/ide that referenced this issue Apr 13, 2023
CREITZ25 added a commit to CREITZ25/ide that referenced this issue Apr 24, 2023
@hohwille hohwille linked a pull request Jun 30, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
2 participants