Common utilities for Camptocamp CI
Project description
C2C CI utils
Commands:
c2cciutils: some generic tools.c2cciutils-checks: Run the checks on the code (those checks don't need any project dependencies).c2cciutils-audit: Do the audit, the main difference with checks is that it can change between runs on the same code.c2cciutils-publish: Publish the project.c2cciutils-clean: Delete Docker images on Docker Hub after corresponding branch have been deleted.c2cciutils-google-calendar: Tool to test the google credentials for calendar API and refresh them if needed. Seec2cciutils-google-calendar -hfor more information.
New project
The content of example-project can be a good base for a new project.
Secrets
In the CI we needs to have the following secrets::
HAS_SECRETSto be set to 'HAS_SECRETS', to avoid error errors from dependabot and from external pull requests, already set globally on camtocamp organisation.GOPASS_CI_GITHUB_TOKENandCI_GPG_PRIVATE_KEYrequired to initialise the gopass password store, the secrets axists in the camptocamp organisation but not shared on all project, then you should add your project to the shared list.
Use locally, in the projects that use c2cciutils
Install it: python3 -m pip install --user --requirement ci/requirements.txt
Run the checkers: c2cciutils-checks [--fix] [--stop] [--check CHECK]
Dry run publish: GITHUB_REF=... c2cciutils-publish --dry-run ...
Configuration
You can get the current configuration with c2cciutils --get-config, the default configuration depends on your project.
You can override the configuration with the file ci/config.yaml.
At the base of the configuration you have:
version: Contains some regular expressions to find the versions branches and tags, and to convert them into application versions.checks: The checkers configuration, seec2cciutils/checks.pyfor more information.audit: The audit configuration, seec2cciutils/audit.pyfor more information.publish: The publish configuration, seec2cciutils/publish.pyfor more information.
Many actions can be disabled by setting the corresponding configuration part to False.
Checks
The configuration profile consider we use a project with:
- Dependabot.
- The following workflows:
Continuous integration,Rebuildon all supported branch,Auditfor security issues on all supported branches,Backportbetween all supported branches,Clean Docker hub tags,Auto merge Dependabot updates.
- A
SECURITY.mdfile.
It will check that:
- All the workflows are conform on what we expect,
- All the workflows are completely configured for all the versions present in
SECURITY.mdfile. - The code is conform with the
blackandisortrules. - The
gitattributesare valid. - All text files end with an empty line.
SECURITY.md
The SECURITY.md file should contains the security policy of the repository, espessially the end of
support dates.
For compatibility with c2cciutils 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 contains 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 can stopped without any notice.To be defined: not yet released or the date will be set related of an other project release date (like for GeoMapFish).
See also GitHub Documentation
IDE
The IDE should be configured as:
- using
blackandisortwithout any arguments, - using the
editorconfigconfiguration.
VScode
- Recommend extensions to work well with c2cciutils:
- Prettier And use EditorConfig
- Other recommend extensions:
Select a formatter:
CTRL+MAJ+P- Format document With...
- Configure Default Formatter...
- Select the formatter
Publishing
To pypi
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:
VERSION = os.environ.get("VERSION", "1.0.0")
The config is like this:
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)
To Docker registry
The config is like this:
latest: True
images:
- name: # The base name of the image we want to publish
repository:
<internal_name>:
'server': # The fqdn name of the server if not Docker hub
'version':# 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)
'tags':# List of tags we want to publish interpreted with `template(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`.
'group':# If your images are published by different jobs you can separate them in different groups
# and publish them with `c2cciutils-publish --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.
With the c2cciutils-clean the images on Docker hub for feature_branch will be removed on branch removing.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for c2cciutils-1.1.dev20240529112453-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5a159bc303ddbd3a86fa471a825acc94c10603b16fc5165df8ccd882947694ed |
|
| MD5 | 4b0f741ab453f7627d3965b0f7a45261 |
|
| BLAKE2b-256 | 524cf80378859737659b3cad1c05da4725b113e3439b1e87d71a4e6f9c87106e |
