Skip to content

Commit

Permalink
docs: update single executable binaries and dev script instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ANGkeith committed Nov 15, 2024
1 parent 3301f2e commit 473100d
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Get rid of all those dev specific shell scripts and make files.
* [Self Hosted Custom Ports](#self-hosted-custom-ports)
* [Development](#development)
* [Scripts](#scripts)
* [Package binaries](#package-binaries)
* [Creating single executable binaries from source](#creating-single-executable-binaries-from-source)

## Installation

Expand Down Expand Up @@ -402,19 +402,29 @@ npm run esbuild
# Run all tests
npm run test
# Run the program with hot-reloading enabled using the `.gitlab-ci.yml` in the root directory
npm run dev

# Pass --help flag into the program
npm run dev -- -- --help # (equivalent of gitlab-ci-local --help)

# Run individual test-case
npx jest tests/test-cases/cache-paths-not-array
```

![example](./docs/images/example.png)

It's also possible to run individual `.gitlab-ci.yml`, via `node src/index.js --cwd examples/docker-compose-nodejs`

### Package binaries
It's also possible to run individual `.gitlab-ci.yml`, via `npx tsx src/index.ts --cwd examples/docker-compose-nodejs`

## Creating single executable binaries from source
```bash
npm install
npm run esbuild

# According to your needs:
npm run pkg-linux
npm run pkg-win
npm run pkg-macos
npm run pkg-all
# the binary will be generated in the respective ./bin/<os>/gitlab-ci-local
```

0 comments on commit 473100d

Please sign in to comment.