Skip to content

Commit 87ffbfe

Browse files
committed
docs: fix --deploy-git-folder description + document buildFromGit constraints and startWithoutCode
- pipeline.mdx: the --deploy-git-folder flag description was a copy of --zerops-yaml-path's text. Corrected to what the flag does per 'zcli service deploy --help': uploads the .git folder with the deploy (ignored by default). - import.mdx buildFromGit: document two constraints verified against the live platform: the repository must be publicly accessible (a private repo fails at clone time with a FAILED build and no build log), and the URL must not carry a trailing .git suffix (fails the same way). - import.mdx: add the startWithoutCode service key (present in the live import JSON schema, previously undocumented): starts a runtime service's containers without waiting for a first deploy.
1 parent 9039fab commit 87ffbfe

2 files changed

Lines changed: 15 additions & 2 deletions

File tree

apps/docs/content/features/pipeline.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -405,8 +405,8 @@ Usage:
405405
Flags:
406406
--archive-file-path string If set, zCLI creates a tar.gz archive with the application code in the required path relative
407407
to the working directory. By default, no archive is created.
408-
--deploy-git-folder Sets a custom path to the zerops.yaml file relative to the working directory. By default zCLI
409-
looks for zerops.yaml in the working directory.
408+
--deploy-git-folder If set, the .git folder is also uploaded with the deploy. By default, the .git folder
409+
is ignored.
410410
-h, --help the service deploy command.
411411
--project-id string If you have access to more than one project, you must specify the project ID for which the
412412
command is to be executed.

apps/docs/content/references/import.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -401,6 +401,19 @@ This example includes all possible configuration options for Zerops services. No
401401
<td className="w-fit">string (URL)</td>
402402
<td className="w-fit">
403403
A URL of a Github or Gitlab repository used for a one-time build of your service.
404+
The repository must be publicly accessible — a private repository fails at clone
405+
time (the build ends FAILED with no build log). Use the plain repository URL
406+
without a trailing `.git` suffix, which fails the same way.
407+
</td>
408+
</tr>
409+
<tr>
410+
<td className="w-fit font-semibold">startWithoutCode</td>
411+
<td className="w-fit">boolean</td>
412+
<td className="w-fit">
413+
Default: `false`<br/>
414+
Set `true` to start a runtime service's containers without waiting for a first
415+
deploy. Useful for provisioning a service whose code arrives later (e.g. via
416+
SSH or a later pipeline run).
404417
</td>
405418
</tr>
406419
<tr>

0 commit comments

Comments
 (0)