Skip to main content

conveyor package release

Build and publish a release version of a package

Synopsis​

Build a release version of a package and release a versioned artifact of the code to Conveyor. This command will publish the versioned artifact as well. Release versions are intended to be used in production, and are referenced by the exact version that is provided to this command. We generate documentation for your package based on Python docstrings.

conveyor package release [flags]

Examples​


The simplest way to create a release build is:
$ conveyor package release --version 1.0.0

To release a package and bump the version to the next valid semantic version, use the following command:
$ conveyor package release --bump minor

If you want to use multiple build args:
$ conveyor package release --version 1.0.0 --build-arg key=value --build-arg key2=value2

If you want to skip generating the documentation, use:
$ conveyor package trial --version 1.0.0 --skip-docs-generation

If you want to use a custom README.md containing your documentation instead of generating one, use:
$ conveyor package trial --version 1.0.0 --skip-docs-generation --documentation-file file://README.md

Options​

      --build-arg list                   Set build-time variables for the containers. Same as Docker build-arg argument
      --build-opts string                Pass additional options to the container runtime (format: space-separated string)
      --bump string                      A bump rule. The available options are: "major", "minor", or "patch"
      --docs-generation-version string   The version of the image to use for documentation generation image
      --documentation-file string        The documentation file for your package version (default "file:///PACKAGE.md")
  -h, --help                             help for release
      --secret stringArray               Secret file to expose to the build (only if BuildKit enabled): id=mysecret,src=/local/secret
      --skip-docs-generation             Generate the documentation for a package based on python docstrings
      --ssh stringArray                  SSH agent socket or keys to expose to the build (only if BuildKit enabled) (format: default|<id>[=<socket>|<key>[,<key>]])
      --version string                   The version to register

Options inherited from parent commands​

      --debug                        Show debug output
      --no-browser NO_BROWSER=true   Do not automatically open a browser at login instead print the url to the command line. You can also use the environment variable NO_BROWSER=true.
  -o, --output string                Change the output. Valid options are table or json (default "table")
      --quiet QUIET=true             Quiet down the output. You can also use the environment variable QUIET=true.

See also​