``create-build-stage`` ====================== .. contents:: :local: :depth: 1 Description ------------ Creates a new stage. Usage ----- .. code-block:: none oci devops build-pipeline-stage create-build-stage [OPTIONS] Required Parameters -------------------- .. option:: --build-pipeline-id [text] The OCID of the build pipeline. .. option:: --build-source-collection [complex type] This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax. The :option:`--generate-param-json-input` option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax. .. option:: --image [text] Image name for the build environment .. option:: --stage-predecessor-collection [complex type] This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax. The :option:`--generate-param-json-input` option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax. Optional Parameters -------------------- .. option:: --build-runner-config [complex type] This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax. The :option:`--generate-param-json-input` option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax. .. option:: --build-spec-file [text] The path to the build specification file for this environment. The default location of the file if not specified is build_spec.yaml. .. option:: --defined-tags [complex type] Defined tags for this resource. Each key is predefined and scoped to a namespace. See `Resource Tags `__. Example: `{"foo-namespace": {"bar-key": "value"}}` This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax. The :option:`--generate-param-json-input` option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax. .. option:: --description [text] Optional description about the stage. .. option:: --display-name [text] Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. .. option:: --freeform-tags [complex type] Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See `Resource Tags `__. Example: `{"bar-key": "value"}` This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax. The :option:`--generate-param-json-input` option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax. .. option:: --from-json [text] Provide input to this command as a JSON document from a file using the file://path-to/file syntax. The :option:`--generate-full-command-json-input` option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id --> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array. Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used. For examples on usage of this option, please see our "using CLI with advanced JSON options" link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions .. option:: --max-wait-seconds [integer] The maximum time to wait for the work request to reach the state defined by ``--wait-for-state``. Defaults to 1200 seconds. .. option:: --network-channel [complex type] This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax. The :option:`--generate-param-json-input` option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax. .. option:: --primary-build-source [text] Name of the build source where the build_spec.yml file is located. If not specified, the first entry in the build source collection is chosen as primary build source. .. option:: --stage-execution-timeout-in-seconds [integer] Timeout for the build stage execution. Specify value in seconds. .. option:: --wait-for-state [text] This operation asynchronously creates, modifies or deletes a resource and uses a work request to track the progress of the operation. Specify this option to perform the action and then wait until the work request reaches a certain state. Multiple states can be specified, returning on the first state. For example, ``--wait-for-state`` SUCCEEDED ``--wait-for-state`` FAILED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned. Accepted values are: .. code-block:: py ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING .. option:: --wait-interval-seconds [integer] Check every ``--wait-interval-seconds`` to see whether the work request has reached the state defined by ``--wait-for-state``. Defaults to 30 seconds. Global Parameters ------------------ Use ``oci --help`` for help on global parameters. :option:`--auth-purpose`, :option:`--auth`, :option:`--cert-bundle`, :option:`--cli-auto-prompt`, :option:`--cli-rc-file`, :option:`--config-file`, :option:`--connection-timeout`, :option:`--debug`, :option:`--defaults-file`, :option:`--endpoint`, :option:`--generate-full-command-json-input`, :option:`--generate-param-json-input`, :option:`--help`, :option:`--latest-version`, :option:`--max-retries`, :option:`--no-retry`, :option:`--opc-client-request-id`, :option:`--opc-request-id`, :option:`--output`, :option:`--profile`, :option:`--proxy`, :option:`--query`, :option:`--raw-output`, :option:`--read-timeout`, :option:`--realm-specific-endpoint`, :option:`--region`, :option:`--release-info`, :option:`--request-id`, :option:`--version`, :option:`-?`, :option:`-d`, :option:`-h`, :option:`-i`, :option:`-v` Example using required parameter ------------------ Copy and paste the following example into a JSON file, replacing the example parameters with your own. .. code-block:: none :class: copy-code-block oci devops project create --generate-param-json-input notification-config > notification-config.json oci devops build-pipeline-stage create-build-stage --generate-param-json-input build-source-collection > build-source-collection.json oci devops build-pipeline-stage create-build-stage --generate-param-json-input stage-predecessor-collection > stage-predecessor-collection.json Copy the following CLI commands into a file named example.sh. Run the command by typing "bash example.sh" and replacing the example parameters with your own. Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up `the OCI configuration `__ and `appropriate security policies `__ before trying the examples. .. code-block:: none :class: copy-code-block export compartment_id= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/project/create.html#cmdoption-compartment-id export name= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/project/create.html#cmdoption-name export image= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/build-pipeline-stage/create-build-stage.html#cmdoption-image project_id=$(oci devops project create --compartment-id $compartment_id --name $name --notification-config file://notification-config.json --query data.id --raw-output) build_pipeline_id=$(oci devops build-pipeline create --project-id $project_id --query data.id --raw-output) oci devops build-pipeline-stage create-build-stage --build-pipeline-id $build_pipeline_id --build-source-collection file://build-source-collection.json --image $image --stage-predecessor-collection file://stage-predecessor-collection.json