diff --git a/README.md b/README.md index 4d7ba9f..b519b4a 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Service startup order: `postgres` + `activemq` + `mariadb` → `panda-server` ```bash # 1. Clone and enter the repository -git clone https://github.com/eic/panda-compose.git +git clone https://github.com/PanDAWMS/panda-compose.git cd panda-compose # 2. Create your environment file (edit secrets as needed) diff --git a/action.yml b/action.yml index 5295a87..c2e8a68 100644 --- a/action.yml +++ b/action.yml @@ -2,7 +2,7 @@ name: 'Setup PanDA' description: > Start a self-contained PanDA server stack via Docker Compose. -author: 'eic' +author: 'PanDAWMS' branding: icon: 'server' @@ -10,7 +10,7 @@ branding: inputs: ref: - description: 'Git ref (branch, tag, SHA) of eic/panda-compose to check out' + description: 'Git ref (branch, tag, SHA) of PanDAWMS/panda-compose to check out' default: 'main' timeout: description: 'Seconds to wait for the PanDA server to become healthy' @@ -39,10 +39,10 @@ outputs: runs: using: 'composite' steps: - - name: Check out eic/panda-compose + - name: Check out PanDAWMS/panda-compose uses: actions/checkout@v6 with: - repository: eic/panda-compose + repository: PanDAWMS/panda-compose ref: ${{ inputs.ref }} path: __panda_compose__ diff --git a/docs/README.md b/docs/README.md index 44624fa..b75b612 100644 --- a/docs/README.md +++ b/docs/README.md @@ -25,7 +25,7 @@ Startup order: `postgres` + `activemq` + `mariadb` → `panda-server` → `init` ## Quick start ```bash -git clone https://github.com/eic/panda-compose.git +git clone https://github.com/PanDAWMS/panda-compose.git cd panda-compose cp .env.example .env docker compose up -d diff --git a/docs/ci-integration.md b/docs/ci-integration.md index dc9f0a6..8dc5caa 100644 --- a/docs/ci-integration.md +++ b/docs/ci-integration.md @@ -9,7 +9,7 @@ The simplest way to integrate PanDA in your CI is with the reusable composite ac ```yaml - name: Setup PanDA - uses: eic/panda-compose@main + uses: PanDAWMS/panda-compose@main ``` This single step starts the full stack and waits for it to be healthy. See @@ -48,7 +48,7 @@ jobs: - name: Checkout panda-compose uses: actions/checkout@v4 with: - repository: eic/panda-compose + repository: PanDAWMS/panda-compose path: panda-compose - name: Start PanDA stack @@ -103,7 +103,7 @@ Pin to a release tag or commit SHA for reproducibility: - name: Checkout panda-compose uses: actions/checkout@v4 with: - repository: eic/panda-compose + repository: PanDAWMS/panda-compose ref: v1.0.0 # or a commit SHA path: panda-compose ``` diff --git a/docs/getting-started.md b/docs/getting-started.md index e4a9c3f..27abb27 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -11,7 +11,7 @@ This page walks you through bringing up the full PanDA stack and submitting your ## 1. Clone the repository ```bash -git clone https://github.com/eic/panda-compose.git +git clone https://github.com/PanDAWMS/panda-compose.git cd panda-compose ``` diff --git a/docs/oci-artifact.md b/docs/oci-artifact.md index 1fe3f31..9cb0782 100644 --- a/docs/oci-artifact.md +++ b/docs/oci-artifact.md @@ -1,7 +1,7 @@ # OCI Artifact panda-compose publishes its `docker-compose.yml` as an OCI artifact to the -[GitHub Container Registry](https://ghcr.io/eic/panda-compose) on every push to `main` +[GitHub Container Registry](https://ghcr.io/PanDAWMS/panda-compose) on every push to `main` and on every version tag. It can also be triggered manually via `workflow_dispatch`. ## What is published @@ -19,7 +19,7 @@ Docker Compose v2.34.0+ `include` and `-f oci://` syntax. ### Inspect the compose configuration ```bash -docker compose -f oci://ghcr.io/eic/panda-compose:latest config +docker compose -f oci://ghcr.io/PanDAWMS/panda-compose:latest config ``` ### Include in another compose file @@ -27,7 +27,7 @@ docker compose -f oci://ghcr.io/eic/panda-compose:latest config ```yaml # docker-compose.yml in an external project include: - - oci://ghcr.io/eic/panda-compose:latest + - oci://ghcr.io/PanDAWMS/panda-compose:latest services: my-tool: @@ -42,7 +42,7 @@ services: > temporary directory. The config files are not present there, so services that require > them will fail to start. > -> **Use [`uses: eic/panda-compose@main`](setup-panda-action.md) in GitHub Actions +> **Use [`uses: PanDAWMS/panda-compose@main`](setup-panda-action.md) in GitHub Actions > instead** — it checks out the full repository (including config files) and waits for > the stack to be healthy before your job continues. @@ -50,8 +50,8 @@ services: ```yaml include: - - oci://ghcr.io/eic/panda-compose:v1 # semver tag - - oci://ghcr.io/eic/panda-compose:latest # always latest main + - oci://ghcr.io/PanDAWMS/panda-compose:v1 # semver tag + - oci://ghcr.io/PanDAWMS/panda-compose:latest # always latest main ``` ## Available tags @@ -82,5 +82,5 @@ The OCI artifact is produced with `docker compose publish --yes`, which: ```bash # install docker compose v2.34.0+ if needed cp .env.example .env -docker compose publish --yes ghcr.io/eic/panda-compose:my-tag +docker compose publish --yes ghcr.io/PanDAWMS/panda-compose:my-tag ``` diff --git a/docs/setup-panda-action.md b/docs/setup-panda-action.md index 7db0b32..837c3a2 100644 --- a/docs/setup-panda-action.md +++ b/docs/setup-panda-action.md @@ -1,29 +1,29 @@ # setup-panda action -The `eic/panda-compose` repository is itself a reusable +The `PanDAWMS/panda-compose` repository is itself a reusable [composite GitHub Action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action). -Referencing it with `uses: eic/panda-compose@main` (or a pinned tag) starts the full +Referencing it with `uses: PanDAWMS/panda-compose@main` (or a pinned tag) starts the full PanDA stack and waits for it to become healthy — in a single step. ## Usage ```yaml - name: Setup PanDA - uses: eic/panda-compose@main + uses: PanDAWMS/panda-compose@main ``` Or pin to a specific release: ```yaml - name: Setup PanDA - uses: eic/panda-compose@v1 + uses: PanDAWMS/panda-compose@v1 ``` ## Inputs | Input | Default | Description | |---|---|---| -| `ref` | `main` | Git ref (branch, tag, SHA) of `eic/panda-compose` to check out. Useful when you need a specific version of the stack config. | +| `ref` | `main` | Git ref (branch, tag, SHA) of `PanDAWMS/panda-compose` to check out. Useful when you need a specific version of the stack config. | | `timeout` | `300` | Seconds to wait for the PanDA server to become healthy. | | `project-name` | `panda-compose` | Docker Compose project name. Determines container name prefixes (e.g. `panda-compose-panda-jedi-1`). Change only if the default conflicts with other services on the runner. | | `env-overrides` | `""` | Newline-separated `KEY=VALUE` pairs appended to `.env` before the stack starts. Use this to override environment-based settings such as default passwords; published host ports remain fixed by the compose file. | @@ -45,7 +45,7 @@ The action writes the following into `$GITHUB_ENV` so all subsequent steps see t | `PANDA_URL_SSL` | `http://localhost:25080/server/panda` | | `X509_USER_PROXY` | `/dev/null` (suppresses grid-proxy warnings) | | `PANDA_COMPOSE_PROJECT` | the `project-name` input value | -| `PANDA_COMPOSE_DIR` | path to the checked-out `eic/panda-compose` tree (`__panda_compose__`) | +| `PANDA_COMPOSE_DIR` | path to the checked-out `PanDAWMS/panda-compose` tree (`__panda_compose__`) | ## Teardown @@ -71,7 +71,7 @@ jobs: - uses: actions/checkout@v4 - name: Setup PanDA - uses: eic/panda-compose@main + uses: PanDAWMS/panda-compose@main - name: Set up Python uses: actions/setup-python@v5 @@ -113,7 +113,7 @@ Use `env-overrides` to change passwords or other settings without modifying `.en ```yaml - name: Setup PanDA - uses: eic/panda-compose@main + uses: PanDAWMS/panda-compose@main with: env-overrides: | PANDA_DB_PASSWORD=my_custom_secret @@ -125,8 +125,8 @@ Use `env-overrides` to change passwords or other settings without modifying `.en For reproducible CI, pin to a release tag or commit SHA: ```yaml -- uses: eic/panda-compose@v1 # semver tag (recommended) -- uses: eic/panda-compose@abc1234 # commit SHA (most precise) +- uses: PanDAWMS/panda-compose@v1 # semver tag (recommended) +- uses: PanDAWMS/panda-compose@abc1234 # commit SHA (most precise) ``` ## Timing