{"_id":"@edgefarm/semantic-release-helm-oci","_rev":"10-a9457d104fb91c207a41eeb82d6365f4","time":{"created":"2022-09-05T20:21:42.494Z","0.0.0":"2022-09-05T13:38:40.614Z","modified":"2022-09-05T20:24:24.251Z","1.0.0":"2022-09-05T18:33:08.822Z","1.0.1":"2022-09-05T18:38:18.011Z","1.1.0":"2022-09-05T19:30:09.356Z","1.2.0":"2022-09-05T20:21:42.693Z","1.2.1":"2022-09-05T20:24:24.179Z"},"name":"@edgefarm/semantic-release-helm-oci","dist-tags":{"latest":"1.2.1"},"versions":{"1.2.0":{"name":"@edgefarm/semantic-release-helm-oci","version":"1.2.0","description":"semantic-release plugin for publishing Helm charts to OCI registries","repository":{"type":"git","url":"git+https://github.com/edgefarm/semantic-release-helm-oci.git"},"main":"index.js","author":{"name":"Armin Schlegel","email":"armin.schlegel@gmx.de"},"license":"MIT","publishConfig":{"access":"public"},"dependencies":{"execa":"^5.0.0","js-yaml":"^4.1.0"},"devDependencies":{"@commitlint/cli":"^13.2.1","@commitlint/config-conventional":"^13.2.0","@semantic-release/git":"^10.0.0","conventional-changelog-conventionalcommits":"^4.6.1","semantic-release-commitlint":"^1.2.2"},"gitHead":"88cfb4f5382c942e19632745800f096537b8de9c","bugs":{"url":"https://github.com/edgefarm/semantic-release-helm-oci/issues"},"homepage":"https://github.com/edgefarm/semantic-release-helm-oci#readme","_id":"@edgefarm/semantic-release-helm-oci@1.2.0","_nodeVersion":"16.17.0","_npmVersion":"8.15.0","dist":{"integrity":"sha512-VZqiwc8/zERxjPe+rGOk30vW9p9YHMxmX/SGYzbKMEPbHU26vIzm/UooNNTXGZyLGZoU11yVaV4nMJ3HVvx3uQ==","shasum":"623926279b2013d6ade38791e5f95235e0eef7ec","tarball":"https://registry.npmjs.org/@edgefarm/semantic-release-helm-oci/-/semantic-release-helm-oci-1.2.0.tgz","fileCount":7,"unpackedSize":9581,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCeij4wCILfjCWu9BPs5RdGyKltdamEZFicGMBpv91dIAIhAJ45KvuzU3hXvIDmQSSIjpZVx4AMFinOx7cJX24x/Hnl"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjFlpWACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmphVw//XG0pcPip9msQTvp3i3Mymmnc0oB9OuJMW9Om6M/mcckbv9oQ\r\nr1XXjTVNxbHjtD4/dSZ79xhqyarZSvoR0YI7wKySKBd1/Lrf8JGa55bc/Ozh\r\nn2aIJP6I+db9eSaUsKHHcJXBDhMuB8LfOszp2LrVQJjD7Idaw+hS5Kz5wCWi\r\nZzEoHrT0jo4odJoVnzO7kaiibLqpy7tC89Z84eJNoW3H28YWc/5uDzA2pPUZ\r\nIFS1MDefexGeiGzqoABzux+hiGbN301zHfLmnLaNU2KOIWgB3zWU+LD49eKK\r\nqF0UN1YnjWnSV5buEFVWakxUcLt9lKoWlOGiEdL4ZiPmwfyF2jZp68Pq5+eX\r\nEgOo7uhoNoQJHhr+evQRa3gh1pCbi67VJC9K+n6EU8YOHaJ5hAW1Bp7T6wZR\r\n+pZRj/MIeiBFtHO281g0UI9MjaSojSAJbTOHOrWV186f9egvjbd6+pGjQhRF\r\nz+St134VZ+zJ8SsweIxruweZjZsp3aLzV2vByawfcTKSsiY8+xkp89dckKR6\r\n87EMm0Bo3OYoVjdMThDfruFvNIGKw58o9EIqFHu3AMkTZstGfMp6B7SrjQGR\r\nFyJ/9XU7Ohh25HiEZq3VX6593NA4fZTLW//XtCU8cE9tw/xBAORjl9J8ajVL\r\nGAFO99PyvGz9pnVeDbVVxGlSTQos7gjJj5U=\r\n=AV2w\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"edgefarm","email":"engineering@ci4rail.com"},"directories":{},"maintainers":[{"name":"edgefarm","email":"engineering@ci4rail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/semantic-release-helm-oci_1.2.0_1662409302537_0.8571501854782779"},"_hasShrinkwrap":false},"1.2.1":{"name":"@edgefarm/semantic-release-helm-oci","version":"1.2.1","description":"semantic-release plugin for publishing Helm charts to OCI registries","repository":{"type":"git","url":"git+https://github.com/edgefarm/semantic-release-helm-oci.git"},"main":"index.js","author":{"name":"Armin Schlegel","email":"armin.schlegel@gmx.de"},"license":"MIT","publishConfig":{"access":"public"},"dependencies":{"execa":"^5.0.0","js-yaml":"^4.1.0"},"devDependencies":{"@commitlint/cli":"^13.2.1","@commitlint/config-conventional":"^13.2.0","@semantic-release/git":"^10.0.0","conventional-changelog-conventionalcommits":"^4.6.1","semantic-release-commitlint":"^1.2.2"},"gitHead":"268254eb53fd9a55fc5ae23f82e084fc035e95df","bugs":{"url":"https://github.com/edgefarm/semantic-release-helm-oci/issues"},"homepage":"https://github.com/edgefarm/semantic-release-helm-oci#readme","_id":"@edgefarm/semantic-release-helm-oci@1.2.1","_nodeVersion":"16.17.0","_npmVersion":"7.24.2","dist":{"integrity":"sha512-EVbqyimlwsD39KM0gojdaK2FuPVHhNMbVOJeB1ondiaYok5gQdtgdOWHt9SZtYLBM/G7wL9PoVptDnA/b2eVzg==","shasum":"3a09257509bf99e38198c527084924841bfafaa8","tarball":"https://registry.npmjs.org/@edgefarm/semantic-release-helm-oci/-/semantic-release-helm-oci-1.2.1.tgz","fileCount":7,"unpackedSize":9644,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD38BktP/GhfMGmvpOrzNVksBzm0lgvSe+M59x3pQ6EfAIgFhaRdEZ1MTVNS4Ig34UPeGM8vvtw3JNm65UKY94muEc="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjFlr4ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmo+iA/+LwzgUshlonuChplQIpRqsZIrd093qEudBl6YP1SmqANEO8wP\r\nDZr2VX1lITyhkLc+P+NuhWDtR8l5BFrz4sg6PK3VRPazJxlnIrRWigWD4oPp\r\n1evLmlmHUqA/4AKDctJQ9D9HdjZ2God5sU0ip2Cnw7AtTY4dW3erLgbr7Lpm\r\n48jJCpfe76/UWTBpX+KLoozBslTvm2qoKW/GFfu9aUMfFuP/vaxVWBDRRA4l\r\n4lnSVaKZPuv9GsnJ2o+go5Ahxscx9C7krkTwWBAUSCMjBycN3LfavrWf9TvU\r\nb1s/C1RCGxHnuqwKqNFvHlMxzK2WkLGEfTmrx/9GtziiF4N4mEF+bqCkS+E3\r\nVo1G+jo0tH5THuE0v5Z2uHYG2+2WYdVB6ZJ4lSJ0ZEDcz5zuTPYcuJOa+6SV\r\nkQmUDUC6tUyEt8cvjBamhAvxAtkYDZ2yJI3dn0J0nn0++fSZYwN5n6aXw68f\r\nJ/gJBIuPcrF9QPtbU1bALIUjmiw+dxptBdzZHkVh1Sa2ixlYF+rMjUd3fEuO\r\nAdkOVV2vrRdIFT0rB0o1QOyWDch2JOMcKzSvuLQyo032GmhJRpcZP+fSgOXs\r\ninE5JflzazhuH3+SwFZGVpiLKHY28regnj0WP+vw1illqy8sG4O26aT/dYky\r\nlf1Z4kLyNfWjZZ2Vv0ppq6uOQ8ylqie1o+8=\r\n=zxnX\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"edgefarm","email":"engineering@ci4rail.com"},"directories":{},"maintainers":[{"name":"edgefarm","email":"engineering@ci4rail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/semantic-release-helm-oci_1.2.1_1662409464004_0.7986098997383415"},"_hasShrinkwrap":false}},"maintainers":[{"name":"edgefarm","email":"engineering@ci4rail.com"}],"description":"semantic-release plugin for publishing Helm charts to OCI registries","homepage":"https://github.com/edgefarm/semantic-release-helm-oci#readme","repository":{"type":"git","url":"git+https://github.com/edgefarm/semantic-release-helm-oci.git"},"author":{"name":"Armin Schlegel","email":"armin.schlegel@gmx.de"},"bugs":{"url":"https://github.com/edgefarm/semantic-release-helm-oci/issues"},"license":"MIT","readme":"# semantic-release-helm-oci\n\n[semantic-release](https://github.com/semantic-release/semantic-release) plugin\nfor publishing Helm charts to OCI compatible registries.\n\n[![NPM](https://img.shields.io/npm/v/@edgefarm/semantic-release-helm-oci?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/@edgefarm/semantic-release-helm-oci)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge)](https://github.com/semantic-release/semantic-release)\n[![MIT License](https://img.shields.io/github/license/edgefarm/semantic-release-helm-oci?logo=mit&style=for-the-badge)](https://opensource.org/licenses/MIT)\n\n| Step               | Description                                              |\n| ------------------ | -------------------------------------------------------- |\n| `verifyConditions` | Verify plugin configuration and login to Helm registry.  |\n| `prepare`          | Package Helm chart to local folder.                      |\n| `publish`          | Publish Helm chart to OCI registry.                      |\n\n## Installation\n\n```bash\nnpm i @edgefarm/semantic-release-helm-oci -D\n```\n\n## Usage\n\nThe plugin can be configured in the [**semantic-release** configuration file\n](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):\n\n**`.releaserc.json`**\n```json\n{\n  \"plugins\": [\n    [\"@edgefarm/semantic-release-helm-oci\", {\n      \"registry\": \"oci://ghcr.io/edgefarm/abc\",\n      \"chartPath\" \"charts/abc\"\n    }]\n  ]\n}\n```\n\n**`.releaserc.yaml`**\n```yaml\nplugins:\n  -\n    - '@edgefarm/semantic-release-helm-oci'\n    - registry: oci://ghcr.io/edgefarm/abc\n      chartPath: \"charts/abc\"\n```\n\nWith this example, for each release, a Helm chart will be published to\n`oci://ghcr.io/edgefarm/abc/${CHART_NAME}:${CHART_VERSION}`.\nWhere `${CHART_NAME}` is a name from `Chart.yaml`\nand `${CHART_VERSION}` is a version detected by semantic-release.\n\n### `version` and `appVersion` in Chart.yaml\n\nPlugin intentionally doesn't modify Chart.yaml during the release.\nIt's recommended to use Git tags for maintaining release versions.\n\nThe plugin leverages `--version` and `--app-version` when calling `helm package`\nto manage published chart versions and not rely on `Chart.yaml`.\n\nThere's two usage scanarios for this plugin:\n\n1. The chart and the application are co-located in the same repository.\n\n    In this case, the `version` and `appVersion` are both changed during a release.\n    This is a default plugin's behaviour.\n\n1. The chart is maintained separately from the application.\n\n    In this case `appVersion` is modified outside of chart's release process\n    and must be updated manually in Chart.yaml. To prevent plugin from setting `--app-version` -\n    use `skipAppVersion` option.\n\n## Configuration\n\n### Environment variables\n\nCredentials for OCI registry authentification are passed through environment variables:\n\n| Variable            | Description                          |\n| ------------------- | ------------------------------------ |\n| `REGISTRY_USERNAME` | **Required.** OCI registry username. |\n| `REGISTRY_PASSWORD` | **Required.** OCI registry password. |\n\n### Options\n\n| Option            | Description                                                       | Type      | Default   |\n| ------------------|-------------------------------------------------------------------|-----------|-----------|\n| `registry`        | **Required.** Registry URL with `oci://` schema,<br>e.g. `oci://ghcr.io/edgefarm/abc`.                      | string    | undefined |\n| `skipAppVersion`  | Use `appVersion` from Chart.yaml when packaging chart, instead of using **semantic-release** `nextVersion` | boolean   | false     |\n| `chartPath`       | Chart directory, where the _Chart.yaml_ is located. | string   | `./`     |\n\n","readmeFilename":"README.md"}