Skip to content

docs: fix --deploy-git-folder description + document buildFromGit constraints and startWithoutCode#350

Merged
krls2020 merged 2 commits into
mainfrom
fix/import-yaml-docs-buildfromgit-startwithoutcode
Jun 19, 2026
Merged

docs: fix --deploy-git-folder description + document buildFromGit constraints and startWithoutCode#350
krls2020 merged 2 commits into
mainfrom
fix/import-yaml-docs-buildfromgit-startwithoutcode

Conversation

@krls2020

Copy link
Copy Markdown
Collaborator

What

Three small reference fixes, each verified against the live platform / live zcli:

  1. pipeline.mdx--deploy-git-folder flag description was wrong. The zcli service deploy flag list described it as "Sets a custom path to the zerops.yaml file" — a copy of --zerops-yaml-path's text two rows below. Per zcli service deploy --help, the flag actually uploads the .git folder with the deploy (ignored by default). Description corrected.

  2. import.mdxbuildFromGit constraints documented. Two failure modes verified against the live platform, both ending in a terminal FAILED build with no build log (hard to diagnose without knowing them):

    • the repository must be publicly accessible — a private repo fails at clone time;
    • a trailing .git suffix on the URL (the conventional clone-URL form) fails the same way.
  3. import.mdxstartWithoutCode service key added. Present in the live import JSON schema (Set true, if you want to start service without code.) but previously undocumented. Added a table row: starts a runtime service's containers without waiting for a first deploy.

🤖 Generated with Claude Code

…straints 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.
@krls2020 krls2020 requested a review from vankovap June 11, 2026 08:52
tikinang
tikinang previously approved these changes Jun 18, 2026

@tikinang tikinang left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jinak 👍

Comment thread apps/docs/content/references/import.mdx Outdated
Comment on lines +414 to +416
Set `true` to start a runtime service's containers without waiting for a first
deploy. Useful for provisioning a service whose code arrives later (e.g. via
SSH or a later pipeline run).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jeste bych pridal "Useful for ... and "playing around" / test commands to be later versioned into zerops.yaml run.prepareCommands". Nebo neco na ten zpusob.

…→ run.prepareCommands workflow

Per review on PR #350: startWithoutCode is also the on-ramp for getting a
bare runtime container to SSH into and experiment in, then versioning the
setup steps into run.prepareCommands so they persist across container
replacements (SSH changes alone are non-persistent). Cross-links the SSH
reference and the zerops.yaml run.prepareCommands spec anchor.
@krls2020 krls2020 requested a review from tikinang June 18, 2026 15:07
@krls2020 krls2020 merged commit 4d015e9 into main Jun 19, 2026
2 checks passed
@krls2020 krls2020 deleted the fix/import-yaml-docs-buildfromgit-startwithoutcode branch June 19, 2026 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants