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

Adjust forms-generation-tool to properly release the cli for Linux, macOS and Windows #424

Closed
porcelli opened this issue Aug 14, 2023 · 11 comments · Fixed by apache/incubator-kie-tools#2123
Assignees
Labels
area:form-generation-tool area:tools Issues affecting Apache KIE tooling projects type:new-feature Something is missing, we need to build it!

Comments

@porcelli
Copy link
Contributor

No description provided.

@porcelli porcelli added the area:tools Issues affecting Apache KIE tooling projects label Aug 14, 2023
@tiagobento tiagobento added the type:new-feature Something is missing, we need to build it! label Aug 14, 2023
@tiagobento tiagobento changed the title Adjust forms-generation-tool to properly release the cli for Linux, Mac and Windows Adjust forms-generation-tool to properly release the cli for Linux, macOS and Windows Aug 14, 2023
@tiagobento
Copy link

Releasing on NPM with a bin entry should be enough for people to be able to use it... All agree?

@porcelli
Copy link
Contributor Author

for now, it's ok!

@jomarko
Copy link

jomarko commented Aug 31, 2023

@tiagobento @porcelli would you mind to add more detailed description, what are acceptance criteria. i see you discussed in comments, but still not sure . Is there any existing librabry on npm repository that can be like example of demanded result?

@ljmotta
Copy link

ljmotta commented Aug 31, 2023

@jomarko The build-env is an example of package that has a bin entry on its package.json. With the bin entry it'll be possible to directly use it in the CLI after the package is installed. Now, to use without node it would require to release the binaries, and for that we need to add steps in our CI as we have for the extended-services and kn-plugin-workflow packages.

@yesamer
Copy link

yesamer commented Jan 8, 2024

@porcelli @tiagobento We completed all the tasks related to form-generation-tool, should we start to work on this ticket too?
//cc @pefernan

@porcelli
Copy link
Contributor Author

porcelli commented Jan 8, 2024

+1 from me

@jomarko
Copy link

jomarko commented Jan 12, 2024

Hello team, I just wonder what are the 'acceptance criteria' here.

  • what should be the cli command name? should it be form-generation-tool? or should the name somehow reflect apache, or kie ?
  • am I correct user will be intended to firstly execute npm install -g @kie-tools/form-generation-tool to make this new cli command available on his/her machine?

I was able to prepare a packages/form-generation-tool/src/cli/cli.js file:

#! /usr/bin/env node
/* License omitted */
require("../../dist/index");

then I prepared update in packages/form-generation-tool/package.json:

  "bin": {
    "form-generation-tool": "./src/cli/cli.js"
  },

and was able to execute it as npm run form-generation-tool from the packages/form-generation-tool folder

However I somehow feel, this is not enough verification before some npm publish is done.

Could somebody help me with better understanding acceptance criteria? How to be sure prepared changes are expected?

@yesamer
Copy link

yesamer commented Jan 16, 2024

  • what should be the cli command name? should it be form-generation-tool? or should the name somehow reflect apache, or kie ?

+1 using form-generation-tool as command name

  • am I correct user will be intended to firstly execute npm install -g @kie-tools/form-generation-tool to make this new cli command available on his/her machine?

I guess this is inevitable, I mean, the user needs to install the library before using that. I don't see alternatives.

@pefernan @tiagobento can you please share your thoughts too?

@jomarko
Copy link

jomarko commented Jan 17, 2024

@yesamer thank you for your input. I prepared a PR when I follow this naming - form-generation-tool.

Anyone, please feel free to have a look on the PR

@pefernan
Copy link

Sorry for being late here,

  • what should be the cli command name? should it be form-generation-tool? or should the name somehow reflect apache, or kie ?

+1 to keep the form-generation-tool name

  • am I correct user will be intended to firstly execute npm install -g @kie-tools/form-generation-tool to make this new cli command available on his/her machine?

+1 too

@jomarko jomarko moved this to ⏳ In Progress in 🦉 KIE Podling Board Jan 18, 2024
@yesamer yesamer closed this as completed Jan 18, 2024
@github-project-automation github-project-automation bot moved this from ⏳ In Progress to 🎯 Done in 🦉 KIE Podling Board Jan 18, 2024
@jomarko
Copy link

jomarko commented Sep 26, 2024

FYI, this feature is cancelled with #1493

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:form-generation-tool area:tools Issues affecting Apache KIE tooling projects type:new-feature Something is missing, we need to build it!
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

7 participants