Pour tout problème contactez-nous par mail : support@froggit.fr | La FAQ :grey_question: | Rejoignez-nous sur le Chat :speech_balloon:

Skip to content
Snippets Groups Projects
Commit 592d9010 authored by Dorian Turba's avatar Dorian Turba
Browse files

Merge branch 'trunk'

parents e6a3bdc6 fa701ea2
No related branches found
No related tags found
No related merge requests found
Pipeline #34472 passed
...@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ...@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased] ## [Unreleased]
## [0.3.4] - 2024-05-12
* Better documentation
## [0.3.3] - 2024-05-12 ## [0.3.3] - 2024-05-12
### Fixed ### Fixed
......
...@@ -4,20 +4,49 @@ ...@@ -4,20 +4,49 @@
## Objective ## Objective
Run release_by_changelog on your project. Publish a new release based on the content of the `CHANGELOG.md` file.
The file must follow the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
format and each release must adhere
to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## How to use it ## How to use it
1. Include the release_by_changelog template in your GitLab CI/CD configuration. ### Include the component/template
2. If you need to customize the job, refer to
the [jobs customization](https://docs.r2devops.io/get-started/use-templates/#job-templates-customization) Add the following to your `.gitlab-ci.yml` file.
documentation.
As a Template:
```yaml
include:
- project: 'swepy/cicd-templates/release-by-changelog'
ref: '0.3.4'
file: 'templates/release-by-changelog.yml'
```
As a Component:
```yaml
# As a Component
include:
- component: $CI_SERVER_FQDN/swepy/cicd-templates/release-by-changelog/release-by-changelog@0.3.4
```
### Customize job
You can customize the job by overriding specific keys. For example:
```yaml
release-by-changelog:
stage: release
variables:
CHANGELOG_FILEPATH: "docs/CHANGELOG.md"
```
## Variables ## Variables
| Name | Description | Default | You can customize the job by overriding the following variables:
|----------------------|----------------------------------------|------------------------------------------------|
| `IMAGE_NAME` | The default name for the docker image. | `"registry.gitlab.com/gitlab-org/release-cli"` | | Name | Description | Default |
| `IMAGE_TAG` | The default tag for the docker image. | `"latest"` | |----------------------|------------------------------------|------------------|
| `IMAGE` | The default docker image name. | `"$IMAGE_NAME:$IMAGE_TAG"` | | `CHANGELOG_FILEPATH` | The path to the CHANGELOG.md file. | `"CHANGELOG.md"` |
| `CHANGELOG_FILEPATH` | The path to the CHANGELOG.md file. | `"CHANGELOG.md"` |
[tool.bumpversion] [tool.bumpversion]
allow-dirty = true
commit = true commit = true
config-file = "pyproject.toml" config-file = "pyproject.toml"
current_version = "0.3.3" current_version = "0.3.4"
parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)" parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
replace = "{new_version}" replace = "{new_version}"
search = "{current_version}" search = "{current_version}"
...@@ -12,7 +11,6 @@ serialize = [ ...@@ -12,7 +11,6 @@ serialize = [
tag = false tag = false
[[tool.bumpversion.files]] [[tool.bumpversion.files]]
allow-dirty = true
filename = "CHANGELOG.md" filename = "CHANGELOG.md"
replace = """## [Unreleased] replace = """## [Unreleased]
...@@ -20,3 +18,9 @@ replace = """## [Unreleased] ...@@ -20,3 +18,9 @@ replace = """## [Unreleased]
""" """
search = """## [Unreleased] search = """## [Unreleased]
""" """
[[tool.bumpversion.files]]
allow-dirty = true
filename = "README.md"
replace = "{new_version}"
search = "{current_version}"
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment