tag-publish 0.7.1__tar.gz

tag_publish-0.7.1/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2020-2024, Camptocamp SA
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+    list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

tag_publish-0.7.1/PKG-INFO

@@ -0,0 +1,210 @@
+Metadata-Version: 2.1
+Name: tag-publish
+Version: 0.7.1
+Summary: Tools used to publish Python packages, Docker images and Helm charts for GitHub tag and branch
+Home-page: https://github.com/camptocamp/tag-publish
+License: FreeBSD
+Keywords: ci
+Author: Camptocamp
+Author-email: info@camptocamp.com
+Requires-Python: >=3.9
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Dist: PyGithub (>=2.0.0,<3.0.0)
+Requires-Dist: PyYAML (>=6.0.0,<7.0.0)
+Requires-Dist: application-download (>=0.0.0,<2.0.0)
+Requires-Dist: debian-inspector (>=31.0.0,<32.0.0)
+Requires-Dist: id (>=1.0.0,<2.0.0)
+Requires-Dist: multi-repo-automation (>=1.0.0,<2.0.0)
+Requires-Dist: requests (>=2.0.0,<3.0.0)
+Requires-Dist: security-md (>=0.0.0,<1.0.0)
+Requires-Dist: twine (>=5.0.0,<6.0.0)
+Project-URL: Repository, https://github.com/camptocamp/tag-publish
+Description-Content-Type: text/markdown
+
+# Tag Publish
+
+## Publishing
+
+The main goals of Tag Publish offer the commands to publish the project,
+see the [documentation](https://github.com/camptocamp/c2cciutils/wiki/Publishing).
+
+## New version
+
+To create a new minor version you just should run `tag-publish-new --version=<version>`.
+
+This will create the stabilization branch and will create a new pull request to update
+the `SECURITY.md` file and the Renovate configuration.
+
+This will also create the tags for the backport.
+
+You are welcome to run `tag-publish-new --help` to see what's it's done.
+
+Note that it didn't create a tag, you should do it manually.
+
+To create a patch version you should just create tag.
+
+## SECURITY.md
+
+The `SECURITY.md` file should contain the security policy of the repository, especially the end of
+support dates.
+
+For compatibility with [`security.md`](https://github.com/sbrunner/security.md/) it should contain an array
+with at least the columns `Version` and `Supported Until`. The `Version` column will contain the concerned
+version.
+The `Supported Until` will contain the date of end of support `dd/mm/yyyy`.
+It can also contain the following sentences:
+
+- `Unsupported`: no longer supported => no audit, no rebuild.
+- `Best effort`: the support is ended, it is still rebuilt and audited, but this can be stopped without any notice.
+- `To be defined`: not yet released or the date will be set related of another project release date (like for GeoMapFish).
+
+See also [GitHub Documentation](https://docs.github.com/en/github/managing-security-vulnerabilities/adding-a-security-policy-to-your-repository)
+
+## Configuration
+
+### Dry run
+
+Dry run publish: `GITHUB_REF=... c2cciutils-publish --dry-run ...`
+
+### To pypi
+
+The config is like this:
+
+```yaml
+versions:
+  # List of kinds of versions you want to publish, that can be:
+  # rebuild (specified with --type),
+  # version_tag, version_branch, feature_branch, feature_tag (for pull request)
+```
+
+It we have a `setup.py` file, we will be in legacy mode:
+When publishing, the version computed from arguments or `GITHUB_REF` is put in environment variable `VERSION`, thus you should use it in `setup.py`, example:
+
+```python
+VERSION = os.environ.get("VERSION", "1.0.0")
+```
+
+Also we consider that we use `poetry` with [poetry-dynamic-versioning](https://pypi.org/project/poetry-dynamic-versioning/) to manage the version, and [poetry-plugin-tweak-dependencies-version](https://pypi.org/project/poetry-plugin-tweak-dependencies-version/) to manage the dependencies versions.
+
+Example of configuration:
+
+```toml
+[tool.poetry-dynamic-versioning]
+enable = true
+vcs = "git"
+pattern = "^(?P<base>\\d+(\\.\\d+)*)"
+format-jinja = """
+{%- if env.get("VERSION_TYPE") == "version_branch" -%}
+{{serialize_pep440(bump_version(base, 1 if env.get("IS_MASTER") == "TRUE" else 2), dev=distance)}}
+{%- elif distance == 0 -%}
+{{serialize_pep440(base)}}
+{%- else -%}
+{{serialize_pep440(bump_version(base), dev=distance)}}
+{%- endif -%}
+"""
+
+```
+
+Note that we can access to the environment variables `VERSION`,`VERSION_TYPE` and `IS_MASTER`.
+
+Then by default:
+
+- Tag with `1.2.3` => release `1.2.3`
+- Commit on feature branch just do a validation
+- Commit on `master` branch after the tag 1.3.0 => release `1.4.0.dev1`
+- Commit on `1.3` branch after the tag 1.3.0 => release `1.3.1.dev1`
+
+#### Authentication
+
+If the file `~/.pypirc` exists we consider that we ar already logged in also
+we will do the login with the `pypi` server with OpenID Connect (OIDC).
+
+The OIDC login is recommended because it didn't needs any additional secrets,
+but it need some configuration on pypi in the package,
+see the [GitHub Documentation](https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-pypi#adding-the-identity-provider-to-pypi).
+
+#### Integration if the package directly in a Docker image
+
+To make it working in the `Dockerfile` you should have in the `poetry` stage:
+
+```Dockerfile
+ENV POETRY_DYNAMIC_VERSIONING_BYPASS=dev
+RUN poetry export --extras=checks --extras=publish --output=requirements.txt \
+    && poetry export --with=dev --output=requirements-dev.txt
+```
+
+And in the `run` stage
+
+```Dockerfile
+ARG VERSION=dev
+RUN --mount=type=cache,target=/root/.cache \
+    POETRY_DYNAMIC_VERSIONING_BYPASS=${VERSION} python3 -m pip install --disable-pip-version-check --no-deps --editable=.
+```
+
+And in the `Makefile`:
+
+```Makefile
+VERSION = $(strip $(shell poetry version --short))
+
+.PHONY: build
+build: ## Build the Docker images
+    docker build --build-arg=VERSION=$(VERSION) --tag=$(GITHUB_REPOSITORY) .
+```
+
+### To Docker registry
+
+The config is like this:
+
+```yaml
+latest: True
+images:
+  - # The base name of the image we want to publish
+    name:
+repository:
+  <internal_name>:
+    # The fqdn name of the server if not Docker hub
+    server:
+    # List of kinds of versions you want to publish, that can be: rebuild (specified using --type),
+    # version_tag, version_branch, feature_branch, feature_tag (for pull request)
+    version:
+    # List of tags we want to publish interpreted with `format(version=version)`
+    # e.g. if you use `{version}-lite` when you publish the version `1.2.3` the source tag
+    # (that should be built by the application build) is `latest-lite`, and it will be published
+    # with the tag `1.2.3-lite`.
+    tags:
+    # If your images are published by different jobs you can separate them in different groups
+    # and publish them with `tag-publish --group=<group>`
+    group:
+```
+
+By default, the last line of the `SECURITY.md` file will be published (`docker`) with the tag
+`latest`. Set `latest` to `False` to disable it.
+
+## Use Renovate to trigger a new build instead of the legacy rebuild
+
+If the `ci/dpkg-versions.yaml` or `.github/dpkg-versions.yaml` file is present, the package list will be updated on publishing.
+
+The versions will be updated by [GHCI](https://github.com/camptocamp/github-app-geo-project/) application.
+
+## Contributing
+
+Install the pre-commit hooks:
+
+```bash
+pip install pre-commit
+pre-commit install --allow-missing-config
+```
+

tag_publish-0.7.1/README.md

@@ -0,0 +1,173 @@
+# Tag Publish
+
+## Publishing
+
+The main goals of Tag Publish offer the commands to publish the project,
+see the [documentation](https://github.com/camptocamp/c2cciutils/wiki/Publishing).
+
+## New version
+
+To create a new minor version you just should run `tag-publish-new --version=<version>`.
+
+This will create the stabilization branch and will create a new pull request to update
+the `SECURITY.md` file and the Renovate configuration.
+
+This will also create the tags for the backport.
+
+You are welcome to run `tag-publish-new --help` to see what's it's done.
+
+Note that it didn't create a tag, you should do it manually.
+
+To create a patch version you should just create tag.
+
+## SECURITY.md
+
+The `SECURITY.md` file should contain the security policy of the repository, especially the end of
+support dates.
+
+For compatibility with [`security.md`](https://github.com/sbrunner/security.md/) it should contain an array
+with at least the columns `Version` and `Supported Until`. The `Version` column will contain the concerned
+version.
+The `Supported Until` will contain the date of end of support `dd/mm/yyyy`.
+It can also contain the following sentences:
+
+- `Unsupported`: no longer supported => no audit, no rebuild.
+- `Best effort`: the support is ended, it is still rebuilt and audited, but this can be stopped without any notice.
+- `To be defined`: not yet released or the date will be set related of another project release date (like for GeoMapFish).
+
+See also [GitHub Documentation](https://docs.github.com/en/github/managing-security-vulnerabilities/adding-a-security-policy-to-your-repository)
+
+## Configuration
+
+### Dry run
+
+Dry run publish: `GITHUB_REF=... c2cciutils-publish --dry-run ...`
+
+### To pypi
+
+The config is like this:
+
+```yaml
+versions:
+  # List of kinds of versions you want to publish, that can be:
+  # rebuild (specified with --type),
+  # version_tag, version_branch, feature_branch, feature_tag (for pull request)
+```
+
+It we have a `setup.py` file, we will be in legacy mode:
+When publishing, the version computed from arguments or `GITHUB_REF` is put in environment variable `VERSION`, thus you should use it in `setup.py`, example:
+
+```python
+VERSION = os.environ.get("VERSION", "1.0.0")
+```
+
+Also we consider that we use `poetry` with [poetry-dynamic-versioning](https://pypi.org/project/poetry-dynamic-versioning/) to manage the version, and [poetry-plugin-tweak-dependencies-version](https://pypi.org/project/poetry-plugin-tweak-dependencies-version/) to manage the dependencies versions.
+
+Example of configuration:
+
+```toml
+[tool.poetry-dynamic-versioning]
+enable = true
+vcs = "git"
+pattern = "^(?P<base>\\d+(\\.\\d+)*)"
+format-jinja = """
+{%- if env.get("VERSION_TYPE") == "version_branch" -%}
+{{serialize_pep440(bump_version(base, 1 if env.get("IS_MASTER") == "TRUE" else 2), dev=distance)}}
+{%- elif distance == 0 -%}
+{{serialize_pep440(base)}}
+{%- else -%}
+{{serialize_pep440(bump_version(base), dev=distance)}}
+{%- endif -%}
+"""
+
+```
+
+Note that we can access to the environment variables `VERSION`,`VERSION_TYPE` and `IS_MASTER`.
+
+Then by default:
+
+- Tag with `1.2.3` => release `1.2.3`
+- Commit on feature branch just do a validation
+- Commit on `master` branch after the tag 1.3.0 => release `1.4.0.dev1`
+- Commit on `1.3` branch after the tag 1.3.0 => release `1.3.1.dev1`
+
+#### Authentication
+
+If the file `~/.pypirc` exists we consider that we ar already logged in also
+we will do the login with the `pypi` server with OpenID Connect (OIDC).
+
+The OIDC login is recommended because it didn't needs any additional secrets,
+but it need some configuration on pypi in the package,
+see the [GitHub Documentation](https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-pypi#adding-the-identity-provider-to-pypi).
+
+#### Integration if the package directly in a Docker image
+
+To make it working in the `Dockerfile` you should have in the `poetry` stage:
+
+```Dockerfile
+ENV POETRY_DYNAMIC_VERSIONING_BYPASS=dev
+RUN poetry export --extras=checks --extras=publish --output=requirements.txt \
+    && poetry export --with=dev --output=requirements-dev.txt
+```
+
+And in the `run` stage
+
+```Dockerfile
+ARG VERSION=dev
+RUN --mount=type=cache,target=/root/.cache \
+    POETRY_DYNAMIC_VERSIONING_BYPASS=${VERSION} python3 -m pip install --disable-pip-version-check --no-deps --editable=.
+```
+
+And in the `Makefile`:
+
+```Makefile
+VERSION = $(strip $(shell poetry version --short))
+
+.PHONY: build
+build: ## Build the Docker images
+    docker build --build-arg=VERSION=$(VERSION) --tag=$(GITHUB_REPOSITORY) .
+```
+
+### To Docker registry
+
+The config is like this:
+
+```yaml
+latest: True
+images:
+  - # The base name of the image we want to publish
+    name:
+repository:
+  <internal_name>:
+    # The fqdn name of the server if not Docker hub
+    server:
+    # List of kinds of versions you want to publish, that can be: rebuild (specified using --type),
+    # version_tag, version_branch, feature_branch, feature_tag (for pull request)
+    version:
+    # List of tags we want to publish interpreted with `format(version=version)`
+    # e.g. if you use `{version}-lite` when you publish the version `1.2.3` the source tag
+    # (that should be built by the application build) is `latest-lite`, and it will be published
+    # with the tag `1.2.3-lite`.
+    tags:
+    # If your images are published by different jobs you can separate them in different groups
+    # and publish them with `tag-publish --group=<group>`
+    group:
+```
+
+By default, the last line of the `SECURITY.md` file will be published (`docker`) with the tag
+`latest`. Set `latest` to `False` to disable it.
+
+## Use Renovate to trigger a new build instead of the legacy rebuild
+
+If the `ci/dpkg-versions.yaml` or `.github/dpkg-versions.yaml` file is present, the package list will be updated on publishing.
+
+The versions will be updated by [GHCI](https://github.com/camptocamp/github-app-geo-project/) application.
+
+## Contributing
+
+Install the pre-commit hooks:
+
+```bash
+pip install pre-commit
+pre-commit install --allow-missing-config
+```

tag_publish-0.7.1/pyproject.toml

@@ -0,0 +1,105 @@
+[tool.ruff]
+line-length = 110
+target-version = "py39"
+
+[tool.ruff.lint]
+fixable = ["ALL"]
+extend-select = [
+  "UP", # pyupgrade
+  "F", # Pyflakes
+  "E", "W", # Pycodestyle
+  "I", # isort
+  "S", # flake8-bandit
+  "SIM", # flake8-simplify
+  "B", # flake8-bugbear
+  # pydocstyle
+  "D213", "D214", "D215", "D405", "D406", "D407", "D408", "D409", "D410", "D411", "D413", "D416", "D417",
+]
+ignore= [
+  "S101", # Use of assert detected
+  "S607", # start-process-with-partial-path
+  "S603", # subprocess-without-shell-equals-true
+]
+exclude = ["tag_publish/configuration.py"]
+
+[tool.mypy]
+python_version = "3.9"
+ignore_missing_imports = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_return_any = true
+strict = true
+
+[tool.poetry]
+name = "tag-publish"
+version = "0.7.1"
+description = "Tools used to publish Python packages, Docker images and Helm charts for GitHub tag and branch"
+readme = "README.md"
+authors = ["Camptocamp <info@camptocamp.com>"]
+keywords = ["ci"]
+repository = "https://github.com/camptocamp/tag-publish"
+license = "FreeBSD"
+packages = [{ include = "tag_publish" }]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Typing :: Typed",
+]
+include = [
+    "tag_publish/py.typed",
+    "tag_publish/*.json",
+]
+exclude = ["tag_publish/node_modules/**/test"]
+
+[tool.poetry.scripts]
+tag-publish = "tag_publish.cli:main"
+tag-publish-new = "tag_publish.new:main"
+
+[tool.poetry.dependencies]
+python = ">=3.9,<4.0"
+requests = "2.32.3"
+twine = "5.1.1"
+PyYAML = "6.0.2"
+id = "1.4.0"
+security-md = "0.2.3"
+application-download = "0.0.1.dev3"
+PyGithub = "2.4.0"
+debian-inspector = "31.1.0"
+multi-repo-automation = "1.4.1"
+
+[tool.poetry.group.dev.dependencies]
+prospector = { version = "1.12.1", extras = ["with-bandit", "with-mypy", "with-pyroma"] }
+prospector-profile-duplicated = "1.6.0"
+prospector-profile-utils = "1.9.1"
+types-requests = "2.32.0.20241016"
+types-pyyaml = "6.0.12.20240917"
+
+[build-system]
+requires = [
+    "poetry-core>=1.0.0",
+    "poetry-dynamic-versioning[plugin]>=0.19.0",
+    "poetry-plugin-tweak-dependencies-version",
+    "poetry-plugin-drop-python-upper-constraint",
+]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry-dynamic-versioning]
+enable = false
+vcs = "git"
+pattern = "^(?P<base>\\d+(\\.\\d+)*)"
+format-jinja = """
+{%- if env.get("VERSION_TYPE") == "version_branch" -%}
+{{serialize_pep440(bump_version(base, 1 if env.get("IS_MASTER") == "TRUE" else 2), dev=distance)}}
+{%- elif distance == 0 -%}
+{{serialize_pep440(base)}}
+{%- else -%}
+{{serialize_pep440(bump_version(base), dev=distance)}}
+{%- endif -%}
+"""
+
+[tool.poetry-plugin-tweak-dependencies-version]
+default = "major"