buildpan-runner v0.0.4

Introduction

BUILDPAN-RUNNER is a powerful Node.js command-line interface (CLI) tool designed to simplify the initialization and management of applications within a defined pipeline configuration. It seamlessly integrates with GitHub Actions workflows locally and Docker, streamlining your development processes.

Installation

To use buildpan-runner, install it globally using npm:

npm install -g buildpan-runner

Commands

Initialization: Initialize the buildpan-runner npm package for your project to set up the required configuration files.

bash
$ buildpan-runner init

Start/Stop Applications: Manage the lifecycle of configured applications by starting or stopping them.
bash
$ buildpan-runner start <appid>
$ buildpan-runner stop <appid>

List Configured Applications: View a table of configured applications, displaying their IDs, names, statuses, paths, and UUIDs.
bash
$ buildpan-runner apps

Kill Service: Terminate the CI/CD service completely or for a specific project.

To kill the CI/CD service completely:
bash
$ buildpan-runner kill

To kill the CI/CD service for a specific project:
bash
$ buildpan-runner kill <appid>

Show Version: Display the version number of the buildpan-runner tool.
bash
$ buildpan-runner -v

Show Available Commands: Display a list of available commands and their usage.
bash
$ buildpan-runner -help

Docker Integration: Execute Docker commands as part of the workflow.

Usage
application.json
A filename CreateApplication.json is automatically create in inside the package in which we Define the properties of our applications.

Example:

{
  "applications": [
    {
      "id": "123",
      "name": "MyApp",
      "path": "/path/to/app",
      "uuid": "abc123def456"
    },
    // Add more applications as needed
  ]
}

buildpan-pipeline.yml
Create a file named buildpan-pipeline.yml in the root of your project. Define the GitHub Actions workflow for buildpan-runner.

Example:

yaml
Copy code
on:
  push:
    branches:
      - main
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v2
      # Add more steps as needed