Contributing

The development flow includes:

• Contributing
  • Start Workspace
  • Build
  • Run tests
  • Run
  • Package binaries
  • Push changes, provide Pull Request
  • Make Release

Start Workspace

To provision a chectl development environment using Eclipse Che, append the URL of the chectl repository to the URL of your Che host, and then visit the resulting URL in your browser. For example, to create a workspace in the Red Hat Developer Sandbox, use the following URL:

https://workspaces.openshift.com/#https://github.com/che-incubator/chectl

See more about devfile See more about workspace URLs

After starting the workspace, Che will clone sources of chectl to the /projects/chectl directory.

chectl is written in TypeScript. For its development, there is a dedicated dev container that has preinstalled software for comfortable development. This allows the developer to build, test, and launch chectl inside the container.

Your workspace will be initialized with a list of commands described in the tasks.json file. The commands are:

• Build
• Test
• Run
• Package Binaries
• Format Sources

You can run commands through the Terminal menu by clicking **Terminal => Run Task... ** and selecting the desired task.

Prerequisites (local development)

If you develop outside of the Che workspace (e.g. on your machine), you need:

• Node.js 18+ (the project uses >=22.0.0; see engines in package.json).
• Corepack enabled so the correct Yarn version is used: run corepack enable once. The project uses Yarn 4 (pinned in packageManager); Corepack will use it when you run yarn.
• Git (required for yarn install postinstall, which fetches operator templates).

In a Che workspace, the devfile and dev container already provide Node and Corepack.

Build

yarn

Running the [Chectl] Build command will run yarn in the /projects/chectl directory inside the dev container. The command installs dependencies and runs the postinstall (including operator template preparation). Upon success, a bin directory appears with run and run.cmd.

Run tests

yarn test

Tests for chectl are written by using the jest framework. To run tests, find and launch the [Chectl] Test command. The command will run yarn test inside dev container. Testing summary will be printed to the output.

Run

./bin/run --help

To test ensure chectl is built successfully, launch the [Chectl] Run command. It wil run chectl with --help directive.

Package binaries

For packaging binaries, oclif is used. It generates packages for Linux, Windows, and MacOS operating systems and puts the result in the dist/ directory. To start packaging, just run the [Chectl] Package Binaries command. It will run the following in the /projects/chectl directory:

yarn oclif pack tarballs --no-xz --parallel

Note: build chectl first with yarn install (or yarn) in the /projects/chectl directory so all dependencies and templates are ready.

Push changes, provide Pull Request

chectl uses several Pull Request checks:

• The Conventional Commits convention for the commit messages. There is a required pull request check named Semantic Pull Request that ensures that all commit messages are correctly set up. In order to merge a pull request, it has to be green.

• Signed Commits. Each commit needs to be Signed-off in the commit message:

  feat(hello): This is my first commit message
  
  Signed-off-by: John Doe <chectl@eclipse.org>
  

  Use the git -s command line option to append this automatically to your commit message:

  $ git commit -s -m 'feat(hello): This is my first commit message'
  

• Unit tests (GitHub Actions) will ensure that the yarn test command passes.

All these checks are mandatory in order to have the pull request merged.

Make Release

Create 7.0.0 version

$ ./make-release.sh 7.0.0

To run the script with docker env

$ ./run-script-in-docker.sh make-release.sh 7.0.0

Commit the changes of the script and then push to the release branch by overriding the current remote release branch.