Skip to content

Commit

Permalink
Merge pull request #1687 from camptocamp/readme
Browse files Browse the repository at this point in the history
Move the publish documentation to the wiki
  • Loading branch information
sbrunner authored May 21, 2024
2 parents 8a05eda + 861c7ca commit 7233c8c
Showing 1 changed file with 2 additions and 26 deletions.
28 changes: 2 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,8 @@

## Publishing

The main goals of C2C CI utils is to offer the commands and the workflows to have the following project structure:

Have stabilization branches named by default `<major>.<minor>`.
Have the release named by default `<major>.<minor>.<patch>`.

With C2C CI utils you can publish a python package and a Docker image from the same repository.

The default publishing are:

- Push on the `<major>.<minor>` branch will publish Docker images.
- Create the tag `<major>.<minor>.<patch>` will publish the Docker images, and the Python package.
- Push on a feature branch (whatever other name) will publish the Docker images.
- Delete a feature branch will delete the Docker images.
- Push on the `master` branch will publish the Docker images with the master tag (Publishing a python package is also possible).
- The version at the last line of the `SECURITY.md` of the `master` branch will be also published using the `latest` tag,
this will respect the `tags` present in the configuration
- In the `SECURITY.md` file of the `master` branch we can also add a column `Alternate Tag` to publish the Docker images with another tag,
this will respect the `tags` present in the configuration (only for Docker).

The Docker images are published on Docker Hub and GitHub Container Registry.

You can run the publishing locally in dry-run mode:

```bash
GITHUB_REF=... c2cciutils-publish --dry-run ...
```
The main goals of C2C CI utils is to offer the commands to publish the project,
see the [documentation](https://github.com/camptocamp/c2cciutils/wiki/Publishing).

## Changelog

Expand Down

0 comments on commit 7233c8c

Please sign in to comment.