Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

exp:expstaticpublish

Publish a target's static build (static publishing): commit it in the target's git repository, tag it static/<target>/<n> and push it, never forced.

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/commands/expstaticpublish.md

On this page

exp:expstaticpublish

Publish a target's static build (static publishing): commit it in the target's git repository, tag it static/<target>/<n> and push it, never forced.

Script bin/php/expstaticpublish.php, code in kernel/private/classes/commands/expstaticpublish.php. Run it from the installation root, as the user the web server runs as:

./console exp:expstaticpublish --help
./console exp:static:publish --help
php bin/php/expstaticpublish.php --help

Help text

Publish a static build to its git remote
Commits the build in the target's folder (var/<site>/static-publish/<target>/, a git repository of
its own: only the files of the build), tags the commit static/<target>/<n> and pushes the branch and
the tag to the target's Remote, signed in with its Credential (a token from Setup > Secrets, a deploy
key, or none). A push is never forced; a push that fails stays local and exp:static:push or the
cronjob part staticpublish tries again. Every publish is a row of exp_static_run.

./console exp:static:publish github-public --build
./console exp:static:publish github-public --nodes=2,57             build these nodes' pages, then publish
./console exp:static:publish github-public --message="New opening hours"
./console exp:static:publish github-public --no-push                commit and tag only

Options

OptionValueHelp
--buildBuild the target first (as exp:static:build); nothing is committed when the build does not finish
--nodesrequiredBuild only the pages of these nodes (node ids; a comma list or repeated), in each siteaccess of the target; the rest of the last build stays
--messagerequiredThe commit message (default: what was published, or which publish is restored)
--no-pushCommit and tag, but do not push (exp:static:push pushes later)
--formatrequiredtext (default) or json (the machine output exp-static/1)
--loginrequiredRun as this user (the administration starts its jobs so); recorded as who ran it
--run-idrequiredThe id of the run (date-time-6 hex digits) instead of a new one (the administration passes its job's id)
--progressrequiredAlso append the progress, one JSON object per line, to this file (the administration follows it)

Read from the option definitions in the code (startup(), getOptions(), options() or ezcConsoleOption). Every script also takes the standard options of the script framework (--help, --siteaccess, --debug, --quiet, --allow-root-user ...).

Arguments: [target].


Generated by ./console exp:help:examples from bin/php/expstaticpublish.php, kernel/private/classes/commands/expstaticpublish.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x