# [chartpress](https://github.com/jupyterhub/chartpress)
[](https://pypi.python.org/pypi/chartpress)
[](https://github.com/jupyterhub/chartpress/actions)
[](https://github.com/jupyterhub/chartpress/issues)
[](https://discourse.jupyter.org/c/jupyterhub)
[](https://gitter.im/jupyterhub/jupyterhub)
Chartpress automate basic Helm chart development work. It is tightly used in development of the [JupyterHub](https://github.com/jupyterhub/zero-to-jupyterhub-k8s) and [BinderHub](https://github.com/jupyterhub/binderhub) Helm charts.
## Features
Chartpress can do the following with the help of some configuration.
- Update Chart.yaml's version appropriately
- Build docker images and tag them appropriately
- Push built images to a docker image repository
- Update values.yaml to reference the built images
- Publish a chart to a Helm chart registry based on GitHub pages
- Reset changes to Chart.yaml and values.yaml
## How chart version and image tags are determined
Chartpress will infer chart versions and image tags using a few key pieces of
information.
1. `tag`: If not directly set by `--tag`, it will be inferred from most recent
commit that is tagged in the _current branch_
(as determined by `git describe`)
or be set to 0.0.1 if no commit is tagged.
1. If the `tag` has a leading `v` but is otherwise a valid
[SemVer2](https://semver.org) version, the `v` will be stripped from Chart.yaml
before its set as Helm 3 requires Helm chart versions to be SemVer2
compliant.
1. The latest commit modifying content in a _relevant path_ since `tag`.
1. `n`: The number of commits since the latest tagged commit on the branch, as an integer.
1. `hash`: The latest commit's abbreviated hash, which is often 7-8 characters,
prefixed with `h`.
1. If `tag` (like `0.10.0` or `0.10.0-beta.1`) contains a `-`, a `tag.git.n.hash`
format will be used, and otherwise a `tag-0.dev.git.n.hash` format will be used.
1. If `--long` is specified or not. If `--long` is specified, tagged commits
will always be written out with the `.git.n.hash` part appended to it, looking something
like `1.0.0-0.dev.git.0.habcd123`
When producing a development version (with `.git.n.hash` on the end),
The _base_ version can come from one of two places,
depending on your configuration.
See [Controlling development version](#controlling-development-versions-in-chart.yaml) for more info.
### Examples chart versions and image tags
This is a list of realistic chart versions and/or image tags in a chronological
order that could come from using chartpress.
```
0.8.0
0.8.0-0.dev.git.4.hasdf123
0.8.0-0.dev.git.10.hsdfg234
0.9.0-beta.1
0.9.0-beta.1.git.12.hdfgh345
0.9.0-beta.1.git.15.hfghj456
0.9.0-beta.2
0.9.0-beta.2.git.20.hghjk567
0.9.0-beta.3
0.9.0
```
## Requirements
The following binaries must be in your `PATH`:
- [git](https://www.git-scm.com/downloads)
- [docker](https://docs.docker.com/install/#supported-platforms)
- [helm](https://helm.sh/docs/using_helm/#installing-helm)
If you are publishing a chart to GitHub Pages create a `gh-pages` branch in the
destination repository.
## Installation
```
pip install chartpress
```
## Usage
In a directory containing a `chartpress.yaml`, run:
chartpress
to build your chart(s) and image(s). Add `--push` to publish images to docker
hub and `--publish-chart` to publish the chart and index to gh-pages.
<!--
To update this help output run
COLUMNS=80 chartpress --help
-->
```
usage: chartpress [-h] [--push] [--force-push] [--publish-chart]
[--force-publish-chart] [--extra-message EXTRA_MESSAGE]
[--tag TAG | --long] [--image-prefix IMAGE_PREFIX] [--reset]
[--no-build | --force-build]
[--builder {docker-build,docker-buildx}]
[--platform PLATFORM] [--list-images] [--version]
Automate building and publishing helm charts and associated images. This is
used as part of the JupyterHub and Binder projects.
optional arguments:
-h, --help show this help message and exit
--push Push built images to their image registries, but not
if it would replace an existing image.
--force-push Push built images to their image registries,
regardless if it would replace an existing image.
--publish-chart Package a Helm chart and publish it to a Helm chart
registry constructed with a GitHub git repository and
GitHub pages, but not if it would replace an existing
chart version.
--force-publish-chart
Package a Helm chart and publish it to a Helm chart
registry constructed with a GitHub git repository and
GitHub pages, regardless if it would replace an
existing chart version
--extra-message EXTRA_MESSAGE
Extra message to add to the commit message when
publishing charts.
--tag TAG Explicitly set the image tags and chart version.
--long Use this to always get a build suffix for the
generated tag and chart version, even when the
specific commit has a tag.
--image-prefix IMAGE_PREFIX
Override the configured image prefix with this value.
--reset Skip image build step and reset Chart.yaml's version
field and values.yaml's image tags. What it resets to
can be configured in chartpress.yaml with the resetTag
and resetVersion configurations.
--no-build, --skip-build
Skip the image build step.
--force-build Enforce the image build step, regardless of if the
image already is available either locally or remotely.
--builder {docker-build,docker-buildx}
Container build engine to use, docker-build is the
standard Docker build command.
--platform PLATFORM Build the image for this platform, e.g. linux/amd64 or
linux/arm64. This argument can be used multiple times
to build multiple platforms under the same tag. Only
supported for docker buildx. If --push is set or if
multiple platforms are passed the image will not be
loaded into the local docker engine.
--list-images print list of images to stdout. Images will not be
built.
--version show program's version number and exit
```
## Configuration
A `chartpress.yaml` file contains a specification of charts and images to build
for each chart. Below is an example `chartpress.yaml` file.
```yaml
charts:
# list of charts by name
# each name should be the name of a Helm chart
- name: binderhub
# Directory containing the chart, relative to chartpress.yaml.
# Can be omitted if the directory is the same as the chart name.
chartPath: helm-charts/binderhub
# the prefix to use for built images
imagePrefix: jupyterhub/k8s-
# tag to use when resetting the chart values
# with the --reset flag. It defaults to "set-by-chartpress".
resetTag: latest
# version to use when resetting the Chart.yaml's version field with the
# --reset flag. It defaults to "0.0.1-set.by.chartpress". This is a valid
# SemVer 2 version, which is required for a helm lint command to succeed.
resetVersion: 1.2.3-dev
# baseVersion sets the base version for development tags,
# instead of using the latest tag from `git describe`.
# This gives you more control over development version tags
# and lets you ensure prerelease tags are always sorted in the right order.
# Only useful when publishing development releases.
# Recommended together with a version-bumping tool like `tbump`.
# if baseVersion is not a prerelease version (no -suffix),
# the suffix `-0.dev` will be appended.
#
# Alternatively baseVersion can be set to "major", "minor", or "patch", then
# baseVersion will be calculated based on the latest version tag from `git
# describe`, but have its "major", "minor", or "patch" version increment if
# the version isn't a pre-release.
baseVersion: 3.2.1-0.dev
# The git repo whose gh-pages contains the charts. This can be a local
# path such as "." as well but if matching <organization>/<repo> will be
# assumed to be a separate GitHub repository.
repo:
git: jupyterhub/helm-chart
published: https://jupyterhub.github.io/helm-chart
# Additional paths that when modified should lead to an updated Chart.yaml
# version, other than the chart directory in <chart name> or any path that
# influence the images of the chart. These paths should be set relative to
# chartpress.yaml's directory.
paths:
- ../setup.py
- ../binderhub
# images to build for this chart (optional)
images:
binderhub:
# imageName overrides the default name of the image. The default name
# is the imagePrefix augmented with the key of this configuration. It
# would be jupyterhub/k8s-binderhub in this case.
imageName: jupyterhub/k8s-custom-image-name
# Build arguments to be passed using docker's --build-arg flag as
# --build-arg <key>=<value>. TAG and LAST_COMMIT are expandable.
buildArgs:
MY_STATIC_BUILD_ARG: "hello world"
MY_DYNAMIC_BUILD_ARG: "{TAG}-{LAST_COMMIT}"
# Build options to be passed to the docker build command. Pass a list
# of strings to be appended to the end of the build command. These are
# passed directly to the command line, so prepend each option with "--"
# like in the examples below. TAG and LAST_COMMIT are expandable.
extraBuildCommandOptions:
- --label=maintainer=octocat
- --label=ref={TAG}-{LAST_COMMIT}
- --rm
# contextPath is the path to the directory that is to be considered the
# current working directory during the build process of the Dockerfile.
# This is by default the folder of the Dockerfile. This path should be
# set relative to chartpress.yaml.
contextPath: ..
# By default, changes to the contextPath will make chartpress rebuild
# the image, but this option make that configurable.
rebuildOnContextPathChanges: false
# Path to the Dockerfile, relative to chartpress.yaml. Defaults to
# "images/<image name>/Dockerfile".
dockerfilePath: images/binderhub/Dockerfile
# Path(s) in <chart name>/values.yaml to be updated with image name and
# tag.
valuesPath:
- singleuser.image
- singleuser.profileList.0.kubespawner_override.image
# Additional paths, relative to chartpress.yaml's directory, that should
# be used to indicate that a new tag of the image is required, aside
# from the contextPath and dockerfilePath for building the image itself.
paths:
- assets
# If chartpress is used to build images for multiple architectures but
# not all of those architectures are supported by an image they can be
# skipped
skipPlatforms:
- linux/arm64
```
### Controlling development versions
Like some "package version in version control" tools,
you don't need to manage versions at all in chartpress except by tagging commits.
However, relying only on tags results in "development versions" (versions published from commits after a release)
having somewhat confusing prerelease versions.
After publishing e.g. `1.2.3`, the next version will be `1.2.3-0.dev.git.10.habc`.
According to Semantic Versioning,
this is a "pre release" (good, it should be excluded from default installation),
but it means it comes _before_ 1.2.3 (wrong! it's 1 commit _newer_ than 1.2.3).
This is because prereleases should be defined relative to the _next_ release,
not the _last_ release. But git tags only store the _last_ release!
Chartpress 2.0 adds an option `chart.baseVersion`,
which allows setting the base version of development tags explicitly,
instead of using the version of the last tag found via `git describe`.
The main benefits of this are:
1. ensuring that published prerelease versions show up in the right order, and
2. giving you control over the version of a prerelease chart (is it 2.0.0-0.dev or 1.3.1-0.dev?)
Instead of publishing the sequence:
- 1.2.3
- 1.2.3-0.dev.git.10.habc (later than 1.2.3, but sorts _before_ 1.2.3!)
You can publish
- 1.2.3
- 1.3.0-0.dev.git.10.habc (prerelease based on the _next_ version, not _last_)
where chartpress will use the version in your `baseVersion` config as the base version,
instead of the last tag on the branch.
This takes some extra configuration, and steps in your release process:
1. You must set `baseVersion: 1.2.3-0.dev` in your chartpress.yaml to your _next_ prerelease:
```yaml
charts:
- name: mychart
baseVersion: 1.2.3-0.dev
```
2. You must update baseVersion, especially after making a release.
We recommend using a version bumping tool like [tbump][] to keep your baseVersion config and git tags in sync.
[tbump]: https://github.com/your-tools/tbump
A release process would generally look like this:
```bash
V=1.2.3
# tbump updates version, commits changes, tags commit, pushes branch and tag
tbump "$V"
# back to development
NEXT_V=1.2.4-0.dev
# bump version config, but no tag for starting development
tbump --no-tag "${NEXT_V}"
```
Any prerelease fields (such as `-0.dev` above, or `-alpha.1`)
will be left as-is, with the `.git.n.hash` suffix added.
If there is no prerelease (e.g. on the exact commit of a tagged release),
`-0.dev` will be added to the base version.
You **must** update baseVersion after making a release,
or `chartpress --reset` will fail due to incorrect ordering of versions.
A sample tbump config file can be found in [our tests](./tests/test_helm_chart/tbump.toml).
## Caveats
### Shallow clones
Chartpress detects the latest commit that changed a directory or file when
determining the version and tag to use for charts and images. This means that
shallow clones should not be used because if the last commit that changed a
relevant file is outside the shallow commit range, the wrong chart version and
image tag will be assigned.
#### Avoiding shallow clones with GitHub Actions
GitHub Workflow's commonly used GitHub Action called actions/checkout have a
clone clone-depth of 1 by default, configure it to make a full clone instead.
```yaml
steps:
- uses: actions/checkout@v2
with:
# chartpress need the git branch's tags and commits
fetch-depth: 0
```
### Command caching
Chartpress caches the results of some commands to improve performance.
This means chartpress should not be used as an importable library.
## Development
Testing of this python package can be done using
[`pytest`](https://github.com/pytest-dev/pytest). For more details on the
testing, see [tests/README.md](tests/README.md).
```bash
# install chartpress locally
pip install -e .
# install dev dependencies
pip install -r dev-requirements.txt
# format and lint code
pre-commit run -a
# run tests
pytest --verbose --exitfirst
# some tests push to a local registry, you can skip these
pytest --verbose --exitfirst -m 'not registry'
```
Raw data
{
"_id": null,
"home_page": "https://github.com/jupyterhub/chartpress",
"name": "chartpress",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "helm,kubernetes",
"author": "Jupyter Development Team",
"author_email": "jupyter@googlegroups.com",
"download_url": "https://files.pythonhosted.org/packages/33/41/66ee3c11ffbf45e54bb34c4611989d36f2d6e8f20c832db704bba3cfe9db/chartpress-2.2.0.tar.gz",
"platform": "Linux",
"description": "# [chartpress](https://github.com/jupyterhub/chartpress)\n\n[](https://pypi.python.org/pypi/chartpress)\n[](https://github.com/jupyterhub/chartpress/actions)\n[](https://github.com/jupyterhub/chartpress/issues)\n[](https://discourse.jupyter.org/c/jupyterhub)\n[](https://gitter.im/jupyterhub/jupyterhub)\n\nChartpress automate basic Helm chart development work. It is tightly used in development of the [JupyterHub](https://github.com/jupyterhub/zero-to-jupyterhub-k8s) and [BinderHub](https://github.com/jupyterhub/binderhub) Helm charts.\n\n## Features\n\nChartpress can do the following with the help of some configuration.\n\n- Update Chart.yaml's version appropriately\n- Build docker images and tag them appropriately\n- Push built images to a docker image repository\n- Update values.yaml to reference the built images\n- Publish a chart to a Helm chart registry based on GitHub pages\n- Reset changes to Chart.yaml and values.yaml\n\n## How chart version and image tags are determined\n\nChartpress will infer chart versions and image tags using a few key pieces of\ninformation.\n\n1. `tag`: If not directly set by `--tag`, it will be inferred from most recent\n commit that is tagged in the _current branch_\n (as determined by `git describe`)\n or be set to 0.0.1 if no commit is tagged.\n 1. If the `tag` has a leading `v` but is otherwise a valid\n [SemVer2](https://semver.org) version, the `v` will be stripped from Chart.yaml\n before its set as Helm 3 requires Helm chart versions to be SemVer2\n compliant.\n1. The latest commit modifying content in a _relevant path_ since `tag`.\n 1. `n`: The number of commits since the latest tagged commit on the branch, as an integer.\n 1. `hash`: The latest commit's abbreviated hash, which is often 7-8 characters,\n prefixed with `h`.\n1. If `tag` (like `0.10.0` or `0.10.0-beta.1`) contains a `-`, a `tag.git.n.hash`\n format will be used, and otherwise a `tag-0.dev.git.n.hash` format will be used.\n1. If `--long` is specified or not. If `--long` is specified, tagged commits\n will always be written out with the `.git.n.hash` part appended to it, looking something\n like `1.0.0-0.dev.git.0.habcd123`\n\nWhen producing a development version (with `.git.n.hash` on the end),\nThe _base_ version can come from one of two places,\ndepending on your configuration.\nSee [Controlling development version](#controlling-development-versions-in-chart.yaml) for more info.\n\n### Examples chart versions and image tags\n\nThis is a list of realistic chart versions and/or image tags in a chronological\norder that could come from using chartpress.\n\n```\n0.8.0\n0.8.0-0.dev.git.4.hasdf123\n0.8.0-0.dev.git.10.hsdfg234\n0.9.0-beta.1\n0.9.0-beta.1.git.12.hdfgh345\n0.9.0-beta.1.git.15.hfghj456\n0.9.0-beta.2\n0.9.0-beta.2.git.20.hghjk567\n0.9.0-beta.3\n0.9.0\n```\n\n## Requirements\n\nThe following binaries must be in your `PATH`:\n\n- [git](https://www.git-scm.com/downloads)\n- [docker](https://docs.docker.com/install/#supported-platforms)\n- [helm](https://helm.sh/docs/using_helm/#installing-helm)\n\nIf you are publishing a chart to GitHub Pages create a `gh-pages` branch in the\ndestination repository.\n\n## Installation\n\n```\npip install chartpress\n```\n\n## Usage\n\nIn a directory containing a `chartpress.yaml`, run:\n\n chartpress\n\nto build your chart(s) and image(s). Add `--push` to publish images to docker\nhub and `--publish-chart` to publish the chart and index to gh-pages.\n\n<!--\nTo update this help output run\nCOLUMNS=80 chartpress --help\n-->\n\n```\nusage: chartpress [-h] [--push] [--force-push] [--publish-chart]\n [--force-publish-chart] [--extra-message EXTRA_MESSAGE]\n [--tag TAG | --long] [--image-prefix IMAGE_PREFIX] [--reset]\n [--no-build | --force-build]\n [--builder {docker-build,docker-buildx}]\n [--platform PLATFORM] [--list-images] [--version]\n\nAutomate building and publishing helm charts and associated images. This is\nused as part of the JupyterHub and Binder projects.\n\noptional arguments:\n -h, --help show this help message and exit\n --push Push built images to their image registries, but not\n if it would replace an existing image.\n --force-push Push built images to their image registries,\n regardless if it would replace an existing image.\n --publish-chart Package a Helm chart and publish it to a Helm chart\n registry constructed with a GitHub git repository and\n GitHub pages, but not if it would replace an existing\n chart version.\n --force-publish-chart\n Package a Helm chart and publish it to a Helm chart\n registry constructed with a GitHub git repository and\n GitHub pages, regardless if it would replace an\n existing chart version\n --extra-message EXTRA_MESSAGE\n Extra message to add to the commit message when\n publishing charts.\n --tag TAG Explicitly set the image tags and chart version.\n --long Use this to always get a build suffix for the\n generated tag and chart version, even when the\n specific commit has a tag.\n --image-prefix IMAGE_PREFIX\n Override the configured image prefix with this value.\n --reset Skip image build step and reset Chart.yaml's version\n field and values.yaml's image tags. What it resets to\n can be configured in chartpress.yaml with the resetTag\n and resetVersion configurations.\n --no-build, --skip-build\n Skip the image build step.\n --force-build Enforce the image build step, regardless of if the\n image already is available either locally or remotely.\n --builder {docker-build,docker-buildx}\n Container build engine to use, docker-build is the\n standard Docker build command.\n --platform PLATFORM Build the image for this platform, e.g. linux/amd64 or\n linux/arm64. This argument can be used multiple times\n to build multiple platforms under the same tag. Only\n supported for docker buildx. If --push is set or if\n multiple platforms are passed the image will not be\n loaded into the local docker engine.\n --list-images print list of images to stdout. Images will not be\n built.\n --version show program's version number and exit\n```\n\n## Configuration\n\nA `chartpress.yaml` file contains a specification of charts and images to build\nfor each chart. Below is an example `chartpress.yaml` file.\n\n```yaml\ncharts:\n # list of charts by name\n # each name should be the name of a Helm chart\n - name: binderhub\n # Directory containing the chart, relative to chartpress.yaml.\n # Can be omitted if the directory is the same as the chart name.\n chartPath: helm-charts/binderhub\n\n # the prefix to use for built images\n imagePrefix: jupyterhub/k8s-\n # tag to use when resetting the chart values\n # with the --reset flag. It defaults to \"set-by-chartpress\".\n resetTag: latest\n # version to use when resetting the Chart.yaml's version field with the\n # --reset flag. It defaults to \"0.0.1-set.by.chartpress\". This is a valid\n # SemVer 2 version, which is required for a helm lint command to succeed.\n resetVersion: 1.2.3-dev\n\n # baseVersion sets the base version for development tags,\n # instead of using the latest tag from `git describe`.\n # This gives you more control over development version tags\n # and lets you ensure prerelease tags are always sorted in the right order.\n # Only useful when publishing development releases.\n # Recommended together with a version-bumping tool like `tbump`.\n # if baseVersion is not a prerelease version (no -suffix),\n # the suffix `-0.dev` will be appended.\n #\n # Alternatively baseVersion can be set to \"major\", \"minor\", or \"patch\", then\n # baseVersion will be calculated based on the latest version tag from `git\n # describe`, but have its \"major\", \"minor\", or \"patch\" version increment if\n # the version isn't a pre-release.\n baseVersion: 3.2.1-0.dev\n\n # The git repo whose gh-pages contains the charts. This can be a local\n # path such as \".\" as well but if matching <organization>/<repo> will be\n # assumed to be a separate GitHub repository.\n repo:\n git: jupyterhub/helm-chart\n published: https://jupyterhub.github.io/helm-chart\n # Additional paths that when modified should lead to an updated Chart.yaml\n # version, other than the chart directory in <chart name> or any path that\n # influence the images of the chart. These paths should be set relative to\n # chartpress.yaml's directory.\n paths:\n - ../setup.py\n - ../binderhub\n # images to build for this chart (optional)\n images:\n binderhub:\n # imageName overrides the default name of the image. The default name\n # is the imagePrefix augmented with the key of this configuration. It\n # would be jupyterhub/k8s-binderhub in this case.\n imageName: jupyterhub/k8s-custom-image-name\n # Build arguments to be passed using docker's --build-arg flag as\n # --build-arg <key>=<value>. TAG and LAST_COMMIT are expandable.\n buildArgs:\n MY_STATIC_BUILD_ARG: \"hello world\"\n MY_DYNAMIC_BUILD_ARG: \"{TAG}-{LAST_COMMIT}\"\n # Build options to be passed to the docker build command. Pass a list\n # of strings to be appended to the end of the build command. These are\n # passed directly to the command line, so prepend each option with \"--\"\n # like in the examples below. TAG and LAST_COMMIT are expandable.\n extraBuildCommandOptions:\n - --label=maintainer=octocat\n - --label=ref={TAG}-{LAST_COMMIT}\n - --rm\n # contextPath is the path to the directory that is to be considered the\n # current working directory during the build process of the Dockerfile.\n # This is by default the folder of the Dockerfile. This path should be\n # set relative to chartpress.yaml.\n contextPath: ..\n # By default, changes to the contextPath will make chartpress rebuild\n # the image, but this option make that configurable.\n rebuildOnContextPathChanges: false\n # Path to the Dockerfile, relative to chartpress.yaml. Defaults to\n # \"images/<image name>/Dockerfile\".\n dockerfilePath: images/binderhub/Dockerfile\n # Path(s) in <chart name>/values.yaml to be updated with image name and\n # tag.\n valuesPath:\n - singleuser.image\n - singleuser.profileList.0.kubespawner_override.image\n # Additional paths, relative to chartpress.yaml's directory, that should\n # be used to indicate that a new tag of the image is required, aside\n # from the contextPath and dockerfilePath for building the image itself.\n paths:\n - assets\n # If chartpress is used to build images for multiple architectures but\n # not all of those architectures are supported by an image they can be\n # skipped\n skipPlatforms:\n - linux/arm64\n```\n\n### Controlling development versions\n\nLike some \"package version in version control\" tools,\nyou don't need to manage versions at all in chartpress except by tagging commits.\n\nHowever, relying only on tags results in \"development versions\" (versions published from commits after a release)\nhaving somewhat confusing prerelease versions.\n\nAfter publishing e.g. `1.2.3`, the next version will be `1.2.3-0.dev.git.10.habc`.\nAccording to Semantic Versioning,\nthis is a \"pre release\" (good, it should be excluded from default installation),\nbut it means it comes _before_ 1.2.3 (wrong! it's 1 commit _newer_ than 1.2.3).\nThis is because prereleases should be defined relative to the _next_ release,\nnot the _last_ release. But git tags only store the _last_ release!\n\nChartpress 2.0 adds an option `chart.baseVersion`,\nwhich allows setting the base version of development tags explicitly,\ninstead of using the version of the last tag found via `git describe`.\n\nThe main benefits of this are:\n\n1. ensuring that published prerelease versions show up in the right order, and\n2. giving you control over the version of a prerelease chart (is it 2.0.0-0.dev or 1.3.1-0.dev?)\n\nInstead of publishing the sequence:\n\n- 1.2.3\n- 1.2.3-0.dev.git.10.habc (later than 1.2.3, but sorts _before_ 1.2.3!)\n\nYou can publish\n\n- 1.2.3\n- 1.3.0-0.dev.git.10.habc (prerelease based on the _next_ version, not _last_)\n\nwhere chartpress will use the version in your `baseVersion` config as the base version,\ninstead of the last tag on the branch.\n\nThis takes some extra configuration, and steps in your release process:\n\n1. You must set `baseVersion: 1.2.3-0.dev` in your chartpress.yaml to your _next_ prerelease:\n\n ```yaml\n charts:\n - name: mychart\n baseVersion: 1.2.3-0.dev\n ```\n\n2. You must update baseVersion, especially after making a release.\n We recommend using a version bumping tool like [tbump][] to keep your baseVersion config and git tags in sync.\n\n[tbump]: https://github.com/your-tools/tbump\n\nA release process would generally look like this:\n\n```bash\nV=1.2.3\n# tbump updates version, commits changes, tags commit, pushes branch and tag\ntbump \"$V\"\n\n# back to development\nNEXT_V=1.2.4-0.dev\n# bump version config, but no tag for starting development\ntbump --no-tag \"${NEXT_V}\"\n```\n\nAny prerelease fields (such as `-0.dev` above, or `-alpha.1`)\nwill be left as-is, with the `.git.n.hash` suffix added.\nIf there is no prerelease (e.g. on the exact commit of a tagged release),\n`-0.dev` will be added to the base version.\nYou **must** update baseVersion after making a release,\nor `chartpress --reset` will fail due to incorrect ordering of versions.\n\nA sample tbump config file can be found in [our tests](./tests/test_helm_chart/tbump.toml).\n\n## Caveats\n\n### Shallow clones\n\nChartpress detects the latest commit that changed a directory or file when\ndetermining the version and tag to use for charts and images. This means that\nshallow clones should not be used because if the last commit that changed a\nrelevant file is outside the shallow commit range, the wrong chart version and\nimage tag will be assigned.\n\n#### Avoiding shallow clones with GitHub Actions\n\nGitHub Workflow's commonly used GitHub Action called actions/checkout have a\nclone clone-depth of 1 by default, configure it to make a full clone instead.\n\n```yaml\nsteps:\n - uses: actions/checkout@v2\n with:\n # chartpress need the git branch's tags and commits\n fetch-depth: 0\n```\n\n### Command caching\n\nChartpress caches the results of some commands to improve performance.\nThis means chartpress should not be used as an importable library.\n\n## Development\n\nTesting of this python package can be done using\n[`pytest`](https://github.com/pytest-dev/pytest). For more details on the\ntesting, see [tests/README.md](tests/README.md).\n\n```bash\n# install chartpress locally\npip install -e .\n\n# install dev dependencies\npip install -r dev-requirements.txt\n\n# format and lint code\npre-commit run -a\n\n# run tests\npytest --verbose --exitfirst\n# some tests push to a local registry, you can skip these\npytest --verbose --exitfirst -m 'not registry'\n```\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "ChartPress: render and publish helm charts and images",
"version": "2.2.0",
"project_urls": {
"Homepage": "https://github.com/jupyterhub/chartpress"
},
"split_keywords": [
"helm",
"kubernetes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f112695a0527b2f60d5f7e4abddcea82569aa8ddd2e2650b1092212c81c38243",
"md5": "db795bed98ac41f5674833c6cdfaa810",
"sha256": "1e2cfc164cc75a03ca1edffe76579989aeded527075ff7a348514610401a3230"
},
"downloads": -1,
"filename": "chartpress-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "db795bed98ac41f5674833c6cdfaa810",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 20626,
"upload_time": "2024-01-11T18:35:36",
"upload_time_iso_8601": "2024-01-11T18:35:36.573014Z",
"url": "https://files.pythonhosted.org/packages/f1/12/695a0527b2f60d5f7e4abddcea82569aa8ddd2e2650b1092212c81c38243/chartpress-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "334166ee3c11ffbf45e54bb34c4611989d36f2d6e8f20c832db704bba3cfe9db",
"md5": "6a364576bbe153440ed908a43136157b",
"sha256": "6741eee884d8961cec03df772c382102a73852c2f44e481a20301e5e95fa5c5f"
},
"downloads": -1,
"filename": "chartpress-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "6a364576bbe153440ed908a43136157b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 35889,
"upload_time": "2024-01-11T18:35:38",
"upload_time_iso_8601": "2024-01-11T18:35:38.267419Z",
"url": "https://files.pythonhosted.org/packages/33/41/66ee3c11ffbf45e54bb34c4611989d36f2d6e8f20c832db704bba3cfe9db/chartpress-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-11 18:35:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jupyterhub",
"github_project": "chartpress",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "chartpress"
}
JSON
