diff --git a/docs/configuration/actions.md b/docs/configuration/actions.md index a897d21974..abff807c57 100644 --- a/docs/configuration/actions.md +++ b/docs/configuration/actions.md @@ -65,8 +65,8 @@ These apply to `propose-downstream` command/job and `pull-from-upstream` job. | | name | working directory | when run | description | |--------|-----------------------|-------------------|-----------------------------------------------------------------------|-----------------------------------------| -| [hook] | `post-upstream-clone` | upstream git repo | after cloning of the upstream repo (main) and before other operations | | -| [hook] | `pre-sync` | upstream git repo | after cloning and checkout to the correct (release) branch | | +| [hook] | `post-upstream-clone` | upstream git repo | after cloning the upstream repo (main) and dist-git target repo and before gpg keys verification and version compatibility check | | +| [hook] | `pre-sync` | upstream git repo | after cloning the upstream repo (main) and dist-git target repo and after gpg keys verification and version compatibility check | | | | `prepare-files` | upstream git repo | after cloning, checking out of both upstream and dist-git repos | replace patching and archive generation | | | `create-patches` | upstream git repo | after sync of upstream files to the downstream | replace patching | | | `get-current-version` | upstream git repo | when the current version needs to be found | expect version as a stdout parameter | @@ -246,8 +246,8 @@ when syncing upstream release downstream, e.g. `rhbz#123 rhbz#124` Related to the `propose-downstream` and `pull-from-upstream` jobs. -* `PACKIT_UPSTREAM_REPO` — absolute path to cloned upstream git repo -* `PACKIT_DOWNSTREAM_REPO` — absolute path to cloned downstream git repo +* `PACKIT_UPSTREAM_REPO` — absolute path to cloned upstream (main) git repo +* `PACKIT_DOWNSTREAM_REPO` — absolute path to cloned downstream (target) git repo List of actions that provide these environment variables: * `post-upstream-clone` diff --git a/docs/configuration/index.md b/docs/configuration/index.md index f0fa5d0011..194964e642 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -534,6 +534,20 @@ should trigger a reaction. should trigger a reaction. +#### version_update_mask +(*string*) This field requires a Python regex pattern. It's used with `re.match`. + The old version contained in the *dist-git target branch specfile* and the *newly released version in upstream* + have both to match this reg exp and the matching value has to be the same otherwise Packit will not sync the + release downstream. + As an example a `version_update_mask`: `\d+\.\d+\.`, a dist-git branch *f39* specfile *version*: *3.8.0* and + a new upstream *release tag*: *3.9.0* are matching but the value is not the same and thus a *3.9.0* release + will not land automatically in *f39*. + +#### version_update_mask_targets +(*list of strings*) Names of the dist-git branches where the `version_update_mask` check should be run. +If `version_update_mask_targets` key is not set but `version_update_mask` is, then the check will be +executed in all *fedora-branched* branches. + ## Aliases To not need to change the config file when the new system version is released,