github.com/apache/incubator-kie-tools/packages/kn-plugin-workflow@v0.28.1-0.20240311201729-34c6856b157f/README.md (about)

     1  # kn-plugin-workflow
     2  
     3  `kn-plugin-workflow` is a plugin of the Knative Client, to enable users to quickly set up a local SonataFlow project from the command line.
     4  
     5  [Read the documentation](https://sonataflow.org/serverlessworkflow/main/testing-and-troubleshooting/kn-plugin-workflow-overview.html)
     6  
     7  ## Build from source
     8  
     9  All the commands in this section should be performed in the monorepo root.
    10  
    11  ### Prerequisites
    12  
    13  - Node `>= 18.14.0` _(To install, follow these instructions: https://nodejs.org/en/download/package-manager/)_
    14  - pnpm `8.7.0` _(To install, follow these instructions: https://pnpm.io/installation)_
    15  - Go `1.21.5` _(To install, follow these instructions: https://go.dev/doc/install)_
    16  
    17  #### Prerequisites for running end-to-end tests
    18  
    19  - docker _(To install, follow these instructions: https://docs.docker.com/engine/install)_
    20  - podman _(To install, follow these instructions: https://podman.io/docs/installation)_
    21  
    22  ### Installing and linking dependencies
    23  
    24  The following command will install the `kn-plugin-workflow` dependencies and link it with any other monorepo
    25  package that is listed in the `package.json`:
    26  
    27  - `pnpm bootstrap -F "@kie-tools/kn-plugin-workflow..."`
    28  
    29  ### Building
    30  
    31  It has two different strategies to build the `kn-plugin-workflow`:
    32  
    33  - `build:dev` _(The build will generate one artifact that is compatible with your local machine)_
    34  - `build:prod` _(The build will generate artifacts for all available architecture and run the available tests)_
    35  
    36  To build the `kn-plugin-workflow` run the following command:
    37  
    38  - `pnpm -r -F "@kie-tools/kn-plugin-workflow..." <build-strategy>`
    39  
    40  #### Plugin/artifact location
    41  
    42  The artifact(s) generated by running the above command are placed in the `packages/kn-plugin-workflow/dist` directory.
    43  
    44  ### End to End Tests
    45  
    46  To build the `kn-plugin-workflow` and run end-to-end tests, use the following commands:
    47  
    48  - `export KIE_TOOLS_BUILD__runEndToEndTests=true`
    49  - `pnpm -r -F "@kie-tools/kn-plugin-workflow..." build:prod`