{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"push","__idx":0},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the push command with the Reunite family of products."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This command is used to push files from another location to a Reunite project."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"The content is overwritten"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The content of the destination folder (in other words the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--mount-path"]},") is overwritten every time changes are detected in comparison to the current content."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"before-you-begin","__idx":1},"children":["Before you begin"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Have the following values ready to use with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push"]}," command:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A user account in a ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://auth.cloud.redocly.com/"},"children":["Reunite project"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An active organization ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/realm/setup/how-to/api-keys"},"children":["API key"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/installation"},"children":["Redocly CLI"]}," installed."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REDOCLY_AUTHORIZATION"]}," environment variable to set the API key."," ","See the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/realm/setup/how-to/api-keys"},"children":["Manage API keys"]}," page in the documentation for details on how to get your API key in Reunite."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"command-usage","__idx":2},"children":["Command usage"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"REDOCLY_AUTHORIZATION=<api-key> redocly push <files> --organization <organizationId> --project <projectId> --mount-path <mountPath> --branch <branch> --message <message> --author <'Author Name <author-email@example.com>'> [--commit-sha <sha>] [--commit-url <url>] [--created-at <commitCreationDate>] [--repository <repositoryId> ] [--namespace <repositoryOrg>] [--default-branch <repositoryDefaultBranch>] [--domain <domain>] [--wait-for-deployment] [--continue-on-deploy-failures] [--replace] [--max-execution-time <timeInSeconds>] [--lint-config <warn | error | off>] [--verbose]\n\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"command-options","__idx":3},"children":["Command options"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["files"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED."]}," List of folders and/or files to upload."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--organization, -o"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED."]}," ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#find-ids"},"children":["Organization ID"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["org_01h1s5z6vf2mm1mz3hevnn9va7"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--project, -p"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED."]}," ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#find-ids"},"children":["Project ID"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prj_01hh1t9sa6gwfv5naz04gr7ehm"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--mount-path, -mp"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED."]}," The path where the files are mounted in the project. Cannot be empty or identical to the project path."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--branch, -b"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED."]}," The branch files are pushed from."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--author, -a"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED."]}," The author of the push in the format: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["'Author Name <author-email@example.com>'"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--message, -m"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED."]}," The commit message for the push."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--commit-sha, -sha"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Commit SHA."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--commit-url, -url"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Commit URL."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--repository"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Repository ID. Example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly-cli"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--namespace"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Repository owner/organization/workspace. Example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Redocly"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--created-at"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Commit creation date. Format: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["yyyy-mm-ddThh:mm:ss+offset value"]},". Example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2024-02-20T14:26:26+02:00"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--domain"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The domain to which the files are pushed. Default value is ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://app.cloud.redocly.com"},"children":["https://app.cloud.redocly.com"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--default-branch"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The default branch of the repository the push originates from. Default value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["main"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--lint-config"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Severity level for configuration file linting. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Possible values:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warn"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["off"]},". Default value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warn"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--max-execution-time"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum wait time for deployment completion in seconds (used in conjunction with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--wait-for-deployment"]}," option). Default value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1200"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--wait-for-deployment"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Waits until the build is completed if it is in progress. Behaves the same as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push-status"]}," command when passed. See ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/push-status"},"children":["push-status"]}," command. Default value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--continue-on-deploy-failures"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Prevents the command from returning a non-zero exit code when the deployment fails. Default value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--replace"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Removes the files under the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--mount-path"]}," that are not part of this push. Default value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--verbose"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Verbose output. Default value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--help"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Help output for the command."]}]}]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["How to find the organization and project IDs",{"$$mdtype":"Tag","name":"Link","attributes":{"id":"find-ids"},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Log in to Reunite."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Organization settings"]}," and copy the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Organization ID"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open the project and copy the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Project ID"]}," from ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Project settings"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Organization and project slugs are still accepted and resolved to IDs before the push, but they are deprecated."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example-usage","__idx":4},"children":["Example usage"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"push-files-to-the-push-docs-project-in-the-default-organization","__idx":5},"children":["Push files to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push-docs"]}," project in the default organization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following command pushes the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["index.md"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["docs/push.yaml"]}," files to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push-docs"]}," project in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly"]}," organization, both given by their IDs:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"REDOCLY_AUTHORIZATION=<api-key> \\\nredocly push index.md docs/push.yaml \\\n          --organization org_01h1s5z6vf2mm1mz3hevnn9va7 \\\n          --project prj_01hh1t9sa6gwfv5naz04gr7ehm \\\n          --mount-path 'docs/push' \\\n          --branch \"docs/push-info\" \\\n          --author \"User <user@example.com>\" \\\n          --message \"Add new docs\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Pushed files are added to an auto-generated preview branch with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-docs/push-info"]}," suffix."," ","The committer is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["User <user@example.com>"]},", and the commit message is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Add new docs"]},"."," ","The files are added inside the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["docs/push"]}," folder in the project (the folder is created if it doesn't exist yet, if the folder does exist then the contents are overwritten)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"push-file-to-the-push-docs-project-in-the-default-organization-and-wait-until-it-is-deployed","__idx":6},"children":["Push file to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push-docs"]}," project in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["default"]}," organization and wait until it is deployed"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This command example does the same as the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#push-files-to-the-push-docs-project-in-the-default-organization"},"children":["previous example"]},", but waits until the preview deployment finishes due to passed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--wait-for-deployment"]}," option:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"REDOCLY_AUTHORIZATION=<api-key> \\\nredocly push docs/push.yaml \\\n          --organization org_01h1s5z6vf2mm1mz3hevnn9va7 \\\n          --project prj_01hh1t9sa6gwfv5naz04gr7ehm \\\n          --mount-path 'docs/push' \\\n          --branch \"docs/push-info\" \\\n          --author \"User <user@example.com>\" \\\n          --message \"Add new docs\" \\\n          --wait-for-deployment\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The command returns when the deployment is completed."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"push-files-and-remove-the-ones-deleted-from-the-source","__idx":7},"children":["Push files and remove the ones deleted from the source"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following command pushes the contents of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["docs"]}," folder."," ","It also removes the files under the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["docs/push"]}," mount path that are not part of this push, for example, files deleted from the source repository since the previous push:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"REDOCLY_AUTHORIZATION=<api-key> \\\nredocly push docs \\\n          --organization org_01h1s5z6vf2mm1mz3hevnn9va7 \\\n          --project prj_01hh1t9sa6gwfv5naz04gr7ehm \\\n          --mount-path 'docs/push' \\\n          --branch \"docs/push-info\" \\\n          --author \"User <user@example.com>\" \\\n          --message \"Sync docs\" \\\n          --replace\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Without ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--replace"]},", the pushed files are added to the mount path and the files that already exist there are kept."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Push each mount path from one source"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["With ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--replace"]},", each push removes the files that earlier pushes added to the same mount path."," ","If several pipelines or commands push to one mount path, push all of their files in a single ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push"]}," command."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"push-files-from-a-github-action-to-the-push-docs-project-in-the-docs-organization-and-wait-until-it-is-deployed","__idx":8},"children":["Push files from a GitHub action to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push-docs"]}," project in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Docs"]}," organization and wait until it is deployed"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following command pushes the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["docs/museum.yaml"]}," file to the project ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push-docs"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Docs"]}," organization."," ","It uses the variables available in the GitHub actions context to supply information to the destination."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"npx @redocly/cli push docs/museum.yaml \\\n              --organization \"Docs\" \\\n              --project \"push-docs\" \\\n              --mount-path \"/docs/remotes/cicd\" \\\n              --default-branch \"${{ github.event.repository.default_branch || github.event.repository.master_branch }}\" \\\n              --branch \"${{ github.ref_name }}\" \\\n              --author \"${{ github.event.head_commit.author.name }} <${{ github.event.head_commit.author.email }}>\" \\\n              --commit-sha \"${{ github.event.head_commit.id }}\" \\\n              --commit-url \"${{ github.event.head_commit.url }}\" \\\n              --namespace \"${{ github.event.repository.owner.login }}\" \\\n              --repository \"${{ github.event.repository.name }}\" \\\n              --created-at \"${{ github.event.head_commit.timestamp }}\" \\\n              --message \"${{ github.event.head_commit.message }}\" \\\n              --wait-for-deployment\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["docs/museum.yaml"]}," file from the repository the action is running on is added to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/docs/remotes/cicd"]}," folder."," ","The change is made on behalf of the latest commit author and uses the most recent commit message."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--commit-sha"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--commit-url"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--namespace"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--repository"]}," options are used to attach the details of the push to the deployment and are also shown on the Reunite \"Deployments\" page."," ","This information is useful in case you have multiple sources for the pushes."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whenever a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push"]}," is performed from the default branch (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--branch \"${{ github.ref_name }}\""]}," and equals to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--default-branch \"${{ github.event.repository.default_branch || github.event.repository.master_branch }}\""]},") - a production deployment starts automatically after a successful preview deployment."," ","In this case the command waits for both deployments to finish."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":9},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/push-status"},"children":["push-status command"]}," to check on an in-progress deploy."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For use in a CI context, check out the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/realm/setup/reference/reunite-push-action"},"children":["GitHub Action"]},"."]}]}]},"frontmatter":{},"tagList":["admonition","html"],"title":"push","lastModified":"2026-10-05T07:10:52.000Z"}