chart_releaser


Namechart_releaser JSON
Version 1.0.2 PyPI version JSON
download
home_page
SummaryHelm chart releaser tools
upload_time2024-01-13 17:35:54
maintainer
docs_urlNone
authorTrusikhin Andrei
requires_python>=3.8
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Helm chart releaser

This tool **requirement helm binary in machine.**

The utility can create a helm package and upload it to the gitlab registry in the **stable** or **develop** channel.
[More information in gitlab documentation](https://docs.gitlab.com/ee/user/packages/helm_repository/)

When uploading to develop channel, the same versions are allowed to be uploaded. When installing helm will take the last downloaded version.

Uploading identical versions to stable channel is forbidden in the code.

# CLI and default vars

1. **-t || --token** - token for registry. Override if env **CHART_RELEASE_TOKEN** is exist.
2. **--ssl** - path to SSL certificate for registry. Override if env **SSL_PATH** is exist. Default value **/usr/local/share/ca-certificates/CA.crt**.
3. **-u || --registry-url** - registry URL, domain only like gitlab.com. Override if env **REGISTRY_URL** is exist. Default **gitlab.com**.
4. **-p || --project-id** - CI_PROJECT_ID for gitlab registry. Override if env **RELEASE_PROJECT_ID** is exist.
5. **-n || --chart-name** - chart name.
6. **-path** - path to Chart.yaml.
7. **-c || --config** - path to config file. Override if env **TOOL_CONFIG_PATH** is exist. Default **hc-releaser.config**. File exist in repository and need for local development, because for gitlab registy must use headers with **JOB-TOKEN** if you usage **CI_JOB_TOKEN** and **PRIVATE-TOKEN** if you usage your private token. This is dynamic paramenter and by default usage **JOB-TOKEN**. If config does not exist usage **JOB_TOKEN** also. 
8. **-b || --branch** - branch for release_stage. 


# Usage

Run helm lint

```bash
hc-releaser helm linting -p <path to helm chart>
```
Optional key **-d** || **--debug** - bolean. If set, helm running with debug mode.

Create and upload pre release helm package

```bash
hc-releaser helm release_stage -t <gitlab_token> -u <gitlab url. Domain only> -p <gitlab_project_id> -n <chart_name> -path <path to dir with Chart.yaml>
```

Create and upload release helm package

```bash
hc-releaser helm release -t <gitlab_token> -u <gitlab url. Domain only> -p <gitlab_project_id> -n <chart_name> -path <path to dir with Chart.yaml>
```

Check version in package registry

```bash
hc-releaser helm check -t <gitlab_token> -u <gitlab url. Domain only> -p <gitlab_project_id> -n <chart_name> -path <path to dir with Chart.yaml>
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "chart_releaser",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "Trusikhin Andrei",
    "author_email": "andrei.trusikhin@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/52/93/5b7a79a01526468b5eb4f24903e7b8ed757462ec6934d4bae95f22c68a7a/chart_releaser-1.0.2.tar.gz",
    "platform": null,
    "description": "# Helm chart releaser\n\nThis tool **requirement helm binary in machine.**\n\nThe utility can create a helm package and upload it to the gitlab registry in the **stable** or **develop** channel.\n[More information in gitlab documentation](https://docs.gitlab.com/ee/user/packages/helm_repository/)\n\nWhen uploading to develop channel, the same versions are allowed to be uploaded. When installing helm will take the last downloaded version.\n\nUploading identical versions to stable channel is forbidden in the code.\n\n# CLI and default vars\n\n1. **-t || --token** - token for registry. Override if env **CHART_RELEASE_TOKEN** is exist.\n2. **--ssl** - path to SSL certificate for registry. Override if env **SSL_PATH** is exist. Default value **/usr/local/share/ca-certificates/CA.crt**.\n3. **-u || --registry-url** - registry URL, domain only like gitlab.com. Override if env **REGISTRY_URL** is exist. Default **gitlab.com**.\n4. **-p || --project-id** - CI_PROJECT_ID for gitlab registry. Override if env **RELEASE_PROJECT_ID** is exist.\n5. **-n || --chart-name** - chart name.\n6. **-path** - path to Chart.yaml.\n7. **-c || --config** - path to config file. Override if env **TOOL_CONFIG_PATH** is exist. Default **hc-releaser.config**. File exist in repository and need for local development, because for gitlab registy must use headers with **JOB-TOKEN** if you usage **CI_JOB_TOKEN** and **PRIVATE-TOKEN** if you usage your private token. This is dynamic paramenter and by default usage **JOB-TOKEN**. If config does not exist usage **JOB_TOKEN** also. \n8. **-b || --branch** - branch for release_stage. \n\n\n# Usage\n\nRun helm lint\n\n```bash\nhc-releaser helm linting -p <path to helm chart>\n```\nOptional key **-d** || **--debug** - bolean. If set, helm running with debug mode.\n\nCreate and upload pre release helm package\n\n```bash\nhc-releaser helm release_stage -t <gitlab_token> -u <gitlab url. Domain only> -p <gitlab_project_id> -n <chart_name> -path <path to dir with Chart.yaml>\n```\n\nCreate and upload release helm package\n\n```bash\nhc-releaser helm release -t <gitlab_token> -u <gitlab url. Domain only> -p <gitlab_project_id> -n <chart_name> -path <path to dir with Chart.yaml>\n```\n\nCheck version in package registry\n\n```bash\nhc-releaser helm check -t <gitlab_token> -u <gitlab url. Domain only> -p <gitlab_project_id> -n <chart_name> -path <path to dir with Chart.yaml>\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Helm chart releaser tools",
    "version": "1.0.2",
    "project_urls": {
        "Documentation": "https://github.com/Onder7994/chart_releaser#readme",
        "Homepage": "https://github.com/Onder7994/chart_releaser",
        "Repository": "https://github.com/Onder7994/chart_releaser"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3d8680f4602e81388a0a34f647a7a95aca84f912890e0aa9f3adb960ac6d38bc",
                "md5": "79be057bd315b678966726a537399433",
                "sha256": "8e0eb1761b94f2c14f95a00627da62ddfc8d213f794e40479b0c1a57816ae8c7"
            },
            "downloads": -1,
            "filename": "chart_releaser-1.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "79be057bd315b678966726a537399433",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7819,
            "upload_time": "2024-01-13T17:35:52",
            "upload_time_iso_8601": "2024-01-13T17:35:52.261892Z",
            "url": "https://files.pythonhosted.org/packages/3d/86/80f4602e81388a0a34f647a7a95aca84f912890e0aa9f3adb960ac6d38bc/chart_releaser-1.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "52935b7a79a01526468b5eb4f24903e7b8ed757462ec6934d4bae95f22c68a7a",
                "md5": "89e067c5326643039b4375984c14237e",
                "sha256": "bb2aa055aa42bf8a38d7dcb4253826f0f2a2fea1baf4fd45cc131d787e73e3da"
            },
            "downloads": -1,
            "filename": "chart_releaser-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "89e067c5326643039b4375984c14237e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 7042,
            "upload_time": "2024-01-13T17:35:54",
            "upload_time_iso_8601": "2024-01-13T17:35:54.105036Z",
            "url": "https://files.pythonhosted.org/packages/52/93/5b7a79a01526468b5eb4f24903e7b8ed757462ec6934d4bae95f22c68a7a/chart_releaser-1.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-13 17:35:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Onder7994",
    "github_project": "chart_releaser#readme",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "chart_releaser"
}
        
Elapsed time: 0.16362s