decidim 0.31.5 → 0.32.0.rc2

data/docs/modules/develop/pages/api/reference/components/proposals/vote.adoc

@@ -0,0 +1,73 @@
+= Vote / Unvote Proposal
+
+== Vote Proposal
+
+To use the API to vote any proposal that is configured to receive votes, you will need to use the following API request.
+
+[source,graphql]
+----
+mutation voteProposal($componentId: ID!, $proposalId: ID!){
+  component(id: $componentId) {
+    ...on ProposalsMutation{
+      proposal(id: $proposalId) {
+        vote(input: {}) {
+        }
+      }
+    }
+  }
+}
+----
+
+Example of submitted variables
+
+[source,json]
+----
+{
+  "componentId": "9",
+  "proposalId": "2"
+}
+----
+
+=== Error Handling
+
+The most frequent errors that can be generated by this mutation are as follows:
+
+* xref:develop:api/reference/errors/unauthorized_mutation.adoc[Unauthorized Mutation Error - MUTATION_NOT_AUTHORIZED_ERROR]
+* xref:develop:api/reference/errors/validation_error.adoc[Validation Error - VALIDATION_ERROR]
+* xref:develop:api/reference/errors/unauthorized_object.adoc[Unauthorized Object Error - UNAUTHORIZED_OBJECT_ERROR]
+
+== Unvote Proposal
+
+To use the API to remove a vote on any proposal that you have already voted, you will need to use the following API request.
+
+[source,graphql]
+----
+mutation unvoteProposal($componentId: ID!, $proposalId: ID!){
+  component(id: $componentId) {
+    ...on ProposalsMutation{
+      proposal(id: $proposalId) {
+        unvote(input: {}) {
+        }
+      }
+    }
+  }
+}
+----
+
+Example of submitted variables
+
+[source,json]
+----
+{
+  "componentId": "9",
+  "proposalId": "2"
+}
+----
+
+=== Error Handling
+
+The most frequent errors that can be generated by this mutation are as follows:
+
+* xref:develop:api/reference/errors/unauthorized_mutation.adoc[Unauthorized Mutation Error - MUTATION_NOT_AUTHORIZED_ERROR]
+* xref:develop:api/reference/errors/validation_error.adoc[Validation Error - VALIDATION_ERROR]
+* xref:develop:api/reference/errors/unauthorized_object.adoc[Unauthorized Object Error - UNAUTHORIZED_OBJECT_ERROR]

data/docs/modules/develop/pages/api/reference/components/proposals/withdraw.adoc

@@ -0,0 +1,38 @@
+= Withdraw Proposal
+
+To use the API to withdraw any proposal that the user has created, you will need to use the following API request.
+
+[source,graphql]
+----
+mutation withdrawProposal($componentId: ID!, $proposalId: ID!){
+  component(id: $componentId) {
+    ...on ProposalsMutation{
+      proposal(id: $proposalId) {
+        withdraw(input: {}) {
+          id
+          state
+          withdrawnAt
+        }
+      }
+    }
+  }
+}
+----
+
+Example of submitted variables
+
+[source,json]
+----
+{
+  "componentId": "9",
+  "proposalId": "2"
+}
+----
+
+== Error Handling
+
+The most frequent errors that can be generated by this mutation are as follows:
+
+* xref:develop:api/reference/errors/unauthorized_mutation.adoc[Unauthorized Mutation Error - MUTATION_NOT_AUTHORIZED_ERROR]
+* xref:develop:api/reference/errors/validation_error.adoc[Validation Error - VALIDATION_ERROR]
+* xref:develop:api/reference/errors/unauthorized_object.adoc[Unauthorized Object Error - UNAUTHORIZED_OBJECT_ERROR]

data/docs/modules/develop/pages/api/reference/components/proposals.adoc

@@ -0,0 +1,14 @@
+= Proposals
+
+In the proposals module we are providing a few mutations that we find useful for day-to-day management of Decidim instance outside the admin.
+
+== For user/participants roles
+
+* xref:develop:api/reference/components/proposals/create.adoc[Create Proposal]
+* xref:develop:api/reference/components/proposals/update.adoc[Update Proposal]
+* xref:develop:api/reference/components/proposals/withdraw.adoc[Withdraw Proposal]
+* xref:develop:api/reference/components/proposals/vote.adoc[Vote Proposal]
+
+== For admin roles
+
+* xref:develop:api/reference/components/proposals/answer.adoc[Answer Proposal]

data/docs/modules/develop/pages/api/reference/errors/attribute_validation_error.adoc

@@ -0,0 +1,38 @@
+= Attribute Validation Error - ATTRIBUTE_VALIDATION_ERROR
+
+This error is triggered when a user submits invalid data into a mutation form. This error is the equivalent of the form validation errors seen in the HTTP version
+
+The JSON response structure is:
+[source, json]
+----
+{
+  "errors": [
+    {
+      "message": [
+        {
+          "path": ["attributes", "title"],
+          "message": "cannot be blank"
+        },
+        {
+          "path": ["attributes", "title"],
+          "message": "is too short (under 15 characters)"}
+      ],
+      "locations": [
+        {
+          "line": 2,
+          "column": 3
+        }
+      ],
+      "path": [
+        "createProposal"
+      ],
+      "extensions": {
+        "code": "ATTRIBUTE_VALIDATION_ERROR"
+      }
+    }
+  ],
+  "data": {
+    "createProposal": null
+  }
+}
+----

data/docs/modules/develop/pages/api/reference/errors/introspection_disabled_error.adoc

@@ -0,0 +1,19 @@
+= Introspection disabled error - INTROSPECTION_DISABLED_ERROR
+
+This error is triggered when a user tries to run introspections, and they do not have the required permissions. By default, Decidim API allows administrators to run introspection queries but restricts them for regular users due to security concerns.
+
+The JSON response structure is:
+
+[source, json]
+----
+{
+  "errors": [
+    {
+      "message": "Introspection is disabled for this request",
+      "extensions": {
+        "code": "INTROSPECTION_DISABLED_ERROR"
+      }
+    }
+  ]
+}
+----

data/docs/modules/develop/pages/api/reference/errors/invalid_locale_error.adoc

@@ -0,0 +1,30 @@
+= Invalid Locale Error - INVALID_LOCALE_ERROR
+
+This error is issued when the user submits or requests content in a language that is not supported by the platform.
+
+The JSON response structure is:
+[source, json]
+----
+{
+  "errors": [
+    {
+      "message": "Invalid locale provided",
+      "locations": [
+        {
+          "line": 2,
+          "column": 3
+        }
+      ],
+      "path": [
+        "createProposal"
+      ],
+      "extensions": {
+        "code": "INVALID_LOCALE_ERROR"
+      }
+    }
+  ],
+  "data": {
+    "createProposal": null
+  }
+}
+----

data/docs/modules/develop/pages/api/reference/errors/locale_error.adoc

@@ -0,0 +1,30 @@
+= Locale Error - LOCALE_ERROR
+
+This error is triggered when the requested language has any internationalization errors, like missing translation string, bad variable replacement (interpolation), or any other I18n errors.
+
+The JSON response structure is:
+[source, json]
+----
+{
+  "errors": [
+    {
+      "message": "There was an error while internally handling i18n data",
+      "locations": [
+        {
+          "line": 2,
+          "column": 39
+        }
+      ],
+      "path": [
+        "createProposal"
+      ],
+      "extensions": {
+        "code": "LOCALE_ERROR"
+      }
+    }
+  ],
+  "data": {
+    "createProposal": null
+  }
+}
+----

data/docs/modules/develop/pages/api/reference/errors/not_found.adoc

@@ -0,0 +1,30 @@
+= Not Found Error - NOT_FOUND_ERROR
+
+This error is triggered when the requested record does not exist in the database, or is in a state where you should not have access to it (moderated, belongs to an unpublished component, belongs to a private process where the requesting user does not have access). This is equivalent to 404 HTTP Status code.
+
+The JSON response structure is:
+[source, json]
+----
+{
+  "errors": [
+    {
+      "message": "ParticipatoryProcess not found",
+      "extensions": {
+        "code": "NOT_FOUND_ERROR"
+      },
+      "locations": [
+        {
+          "line": 2,
+          "column": 3
+        }
+      ],
+      "path": [
+        "participatoryProcess"
+      ]
+    }
+  ],
+  "data": {
+    "participatoryProcess": null
+  }
+}
+----

data/docs/modules/develop/pages/api/reference/errors/permission_not_set.adoc

@@ -0,0 +1,46 @@
+= Permission Not Set Error - PERMISSION_NOT_SET_ERROR
+
+This is an error that should not be seen by end users, as this error is being fired when a request passes through a managed permission handler.
+
+The JSON response structure is:
+[source, json]
+----
+{
+  "errors": [
+    {
+      "message": "Permission has not been set for this Project",
+      "locations": [
+        {
+          "line": 3,
+          "column": 5
+        }
+      ],
+      "path": [
+        "participatoryProcess",
+        "components",
+        0,
+        "budget",
+        "projects",
+        0
+      ],
+      "extensions": {
+        "code": "PERMISSION_NOT_SET_ERROR"
+      }
+    }
+  ],
+  "data": {
+    "participatoryProcess": {
+      "components": [
+        {
+          "id": "3",
+          "budget": {
+            "projects": [
+              null
+            ]
+          }
+        }
+      ]
+    }
+  }
+}
+----

data/docs/modules/develop/pages/api/reference/errors/recursion_limit_exceeded_error.adoc

@@ -0,0 +1,19 @@
+= Recursion limit error - RECURSION_LIMIT_EXCEEDED_ERROR
+
+This error is triggered when your query uses a GraphQL circular reference for more than two times. By default, Decidim API restricts the circular reference calls due to security and performance issues.
+
+The JSON response structure is:
+
+[source, json]
+----
+{
+  "errors": [
+    {
+      "message": "Too many recursions detected in query",
+      "extensions": {
+        "code": "RECURSION_LIMIT_EXCEEDED_ERROR"
+      }
+    }
+  ]
+}
+----

data/docs/modules/develop/pages/api/reference/errors/too_many_aliases_error.adoc

@@ -0,0 +1,23 @@
+= Too many Aliases error - TOO_MANY_ALIASES_ERROR
+
+This error is triggered when your query has too many aliases.
+To avoid this, you should do any of the following:
+
+- Simplify the query
+- If you are unable, ask for the implementer of the instance to change the `API_SCHEMA_MAX_ALIASES` environment variable. (xref:configure:environment_variables.adoc[Environment Variables page])
+
+The JSON response structure is:
+
+[source, json]
+----
+{
+  "errors": [
+    {
+      "message": "Too many aliases used. You have used 51 aliases, but 5 are allowed.",
+      "extensions": {
+        "code": "TOO_MANY_ALIASES_ERROR"
+      }
+    }
+  ]
+}
+----

data/docs/modules/develop/pages/api/reference/errors/unauthorized_field.adoc

@@ -0,0 +1,30 @@
+= Unauthorized Field Error - UNAUTHORIZED_FIELD_ERROR
+
+This error is triggered when the requesting user does not have access to a certain field, or a certain resource.
+
+The JSON response structure is:
+[source, json]
+----
+{
+  "errors": [
+    {
+      "message": "You cannot view or edit answer field on Answer because you do not have permission",
+      "locations": [
+        {
+          "line": 2,
+          "column": 3
+        }
+      ],
+      "path": [
+        "answer"
+      ],
+      "extensions": {
+        "code": "UNAUTHORIZED_FIELD_ERROR"
+      }
+    }
+  ],
+  "data": {
+    "answer": null
+  }
+}
+----

data/docs/modules/develop/pages/api/reference/errors/unauthorized_mutation.adoc

@@ -0,0 +1,30 @@
+= Unauthorized Mutation Error - MUTATION_NOT_AUTHORIZED_ERROR
+
+This error is triggered when a user submits a mutation request to a resource they do not have access to.
+
+The JSON response structure is:
+[source, json]
+----
+{
+  "errors": [
+    {
+      "message": "You do not have permission to perform this mutation",
+      "locations": [
+        {
+          "line": 2,
+          "column": 3
+        }
+      ],
+      "path": [
+        "createProposal"
+      ],
+      "extensions": {
+        "code": "MUTATION_NOT_AUTHORIZED_ERROR"
+      }
+    }
+  ],
+  "data": {
+    "createProposal": null
+  }
+}
+----

data/docs/modules/develop/pages/api/reference/errors/unauthorized_object.adoc

@@ -0,0 +1,30 @@
+= Unauthorized Object Error - UNAUTHORIZED_OBJECT_ERROR
+
+This error is triggered when the requesting user does not have access to a certain resource.
+
+The JSON response structure is:
+[source, json]
+----
+{
+  "errors": [
+    {
+      "message": "You cannot view or edit this Result because you do not have permissions",
+      "locations": [
+        {
+          "line": 2,
+          "column": 3
+        }
+      ],
+      "path": [
+        "vote"
+      ],
+      "extensions": {
+        "code": "UNAUTHORIZED_OBJECT_ERROR"
+      }
+    }
+  ],
+  "data": {
+    "result": null
+  }
+}
+----

data/docs/modules/develop/pages/api/reference/errors/validation_error.adoc

@@ -0,0 +1,30 @@
+= Validation Error - VALIDATION_ERROR
+
+This error is triggered when the requesting user performs an action that contains an error, for example, when the user tries to publish a resource that is already published. This is equivalent to the flash messages displayed on the Website.
+
+The JSON response structure is:
+[source, json]
+----
+{
+  "errors": [
+    {
+      "message": "There was a problem voting the proposal.",
+      "locations": [
+        {
+          "line": 2,
+          "column": 3
+        }
+      ],
+      "path": [
+        "vote"
+      ],
+      "extensions": {
+        "code": "VALIDATION_ERROR"
+      }
+    }
+  ],
+  "data": {
+    "vote": null
+  }
+}
+----

data/docs/modules/develop/pages/api/reference/errors.adoc

@@ -0,0 +1,29 @@
+= Error Handling for the API
+
+Currently, in Decidim we are using some exceptions to handle API responses, aiming to serve both input (receiving data through API) and output (sending data through API).
+
+At the moment there are 4 categories of exceptions that are being handled:
+
+== System Errors
+
+* xref:develop:api/reference/errors/too_many_aliases_error.adoc[Too many aliases error - TOO_MANY_ALIASES_ERROR] - is triggered when your query uses too many aliases.
+* xref:develop:api/reference/errors/recursion_limit_exceeded_error.adoc[Recursion limit error - RECURSION_LIMIT_EXCEEDED_ERROR] - is triggered when your query uses a GraphQL circular reference for more than two times.
+* xref:develop:api/reference/errors/introspection_disabled_error.adoc[Introspection disabled error - INTROSPECTION_DISABLED_ERROR] - is triggered when a user attempts to run introspection and they do not have the required permissions.
+
+== Authorization errors
+
+* xref:develop:api/reference/errors/permission_not_set.adoc[Permission Not Set Error - PERMISSION_NOT_SET_ERROR], is triggered when there is a problem with the authorization layer.
+* xref:develop:api/reference/errors/unauthorized_object.adoc[Unauthorized Object Error - UNAUTHORIZED_OBJECT_ERROR], is triggered when the requesting user does not have access to a certain resource.
+* xref:develop:api/reference/errors/unauthorized_field.adoc[Unauthorized Field Error - UNAUTHORIZED_FIELD_ERROR], is triggered when the requesting user does not have access to a certain field or resource.
+* xref:develop:api/reference/errors/unauthorized_mutation.adoc[Unauthorized Mutation Error - MUTATION_NOT_AUTHORIZED_ERROR], is triggered when the requesting user tries to access a mutation that cannot be accessed.
+
+== Validation errors
+
+* xref:develop:api/reference/errors/not_found.adoc[Not Found Error - NOT_FOUND_ERROR], is triggered when the requested record does not exist in database, or is in a state where you should not have access to it (moderated, belongs to an unpublished component, belongs to a private process where the requesting user does not have access)
+* xref:develop:api/reference/errors/validation_error.adoc[Validation Error - VALIDATION_ERROR], is triggered when the requesting user performs an action that contains an error. This is equivalent to the flash messages displayed on the Website.
+* xref:develop:api/reference/errors/attribute_validation_error.adoc[Attribute Validation Error - ATTRIBUTE_VALIDATION_ERROR], is triggered when the requesting user submits a request to alter a resource that has an error. This is equivalent to the validation errors in the HTTP forms.
+
+== Internationalization errors
+
+* xref:develop:api/reference/errors/locale_error.adoc[Locale Error - LOCALE_ERROR], is triggered when there is a problem with the internationalization, for example, a missing translation, a missing interpolation to the output string
+* xref:develop:api/reference/errors/invalid_locale_error.adoc[Invalid Locale Error - INVALID_LOCALE_ERROR], is triggered when the provided locale is invalid or not supported by the system, for example when an unknown locale code is used or a locale that is not enabled for the current organization

data/docs/modules/develop/pages/backports.adoc

@@ -2,37 +2,118 @@
 
 We only offer support for the last two mayor version.
 
-For instance, if we are on the version `0.28.0.dev`, we make backports for `v0.26.x` and `v0.27.x`. We only backport fixes and not features, as we want to respect xref:develop:guide_conventions.adoc[Semantic Versioning].
+For instance, if we are on the version `0.32.0.dev`, we make backports for `v0.31.x` and `v0.30.x`. We only backport fixes and not features, as we want to respect xref:develop:guide_conventions.adoc[Semantic Versioning].
 
 The idea of a backport is to bring a given fix from the last development version to an older release.
 
 The process for making backports is the following:
 
-. Check in the git commit history what was the latest backports on the branch that you are working with. https://github.com/decidim/decidim/commits/release/0.27-stable[Example for v0.27]. Copy the number of the last PR backported.
-. Search in GitHub for the this PR in the list of merged PRs of the `type: fix`. https://github.com/decidim/decidim/pulls?page=1&q=is%3Apr+sort%3Aupdated-desc+label%3A%22type%3A+fix%22+is%3Amerged[Example URL].
-. Check the PRs merged just before and after this one. You need to find the last ones that were not backported already to start with the backport process. A fast way for checking this out is to open the PRs and see the mentions from the backports in the GitHub references.
-. Once you have the list of the PRs that you want to backport, you can start with the process by using the https://github.com/decidim/decidim-maintainers_toolbox[decidim-backporter script]. This script mostly handles the branch creation, cherrypicking, labeling and pushing of the fix. For using it you will need to have a GitHub Personal Access Token.
+. Reproduce the error against develop.
+. Develop a fix for the issue, starting from the develop.
+. Open the Pull Request, adding the following labels: `type: fix`, `release: 0.xx`, in our example using `0.32.0.dev`, we would attach `type: fix`, `release: v0.31`.
+. If the fix affects multiple versions, attach the corresponding release tag (for instance, `release: v0.30`).
+. Be patient and wait for a maintainer to review and merge.
+. Once it is merged, an automated workflow will attempt to apply the patch.
+. If you have an already merged Pull Request, you can add another `release: v0.xx` tag, and this will retrigger the backport workflow. You do not need to decide when you open the PR which are the versions you want to backport to.
 
-This is an example on how this command is called:
+== Maintainers only
 
-```shell
-$ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-$ decidim-backporter --github-token=GITHUB_TOKEN --pull-request-id=10248 --version-number=0.27
-```
+In order to ease up the backport process, you will need to install the `decidim-maintainers_toolbox` gem.
 
-And this is the current full documentation for this script:
+[source,bash]
+----
+gem install decidim-maintainers_toolbox
+----
 
-```shell
-$ decidim-backporter --help
+This will provide you with some commands that you can use for day to day activities:
+
+Before starting to use `decidim-maintainers_toolbox` gem, you will need to make sure that you have available the `gh` command, provided by `GitHub`. Follow the https://github.com/cli/cli[gh project's page] for installation steps that are most suited for your Operating System.
+
+=== decidim-backports-checker
+
+The `decidim-backports-checker` is an utility that you can use to investigate which are the Pull Requests that needs to be backported.
+
+[source, bash]
+----
+Usage:
+  decidim-backports-checker --github-token=GITHUB_TOKEN --last-version-number=LAST_VERSION_NUMBER
+
+Options:
+--github-token=GITHUB_TOKEN                # Required. Github Personal Access Token (PAT). It can be obtained from https://github.com/settings/tokens/new. You will need to create one with `public_repo` access.
+Alternatively, you can use the `gh` CLI tool to authenticate with `gh auth token` (i.e. --github-token=$(gh auth token))
+--last-version-number=LAST_VERSION_NUMBER  # Required. The version number of the last supported version that you want to do the backports to. It must have the format MAJOR.MINOR.
+[--days-to-check-from=N]                   # How many days since the pull requests were merged we will check from.
+# Default: 90
+
+Backports checker. Shows the status of the pull requests opened in the last days
+
+The output by default is for the terminal. It uses a color code to differentiate the status of the Pull Requests, following the colors of GitHub:
+- Purple: closed with a merge
+- Red: closed without being merge
+- Green: opened without being merge
+----
+
+Any maintainer that wants to see the pending Pull Requests that needs to be backported to a specific version, should type in the following command:
+
+[source, bash]
+----
+decidim-backports-checker --github-token=$(gh auth token) --last-version-number=0.31
+----
+In our previous example, we have the develop branch set to be on 0.32.0.dev, which means that our latest released minor version is 0.31. We are using the minor version regardless if we are at `0.31.0.rc2`, `0.31.0` or `0.31.1`.
+
+image::maintainers-backports-checker.png[decidim-backports-checker output]
+
+In the above picture:
+
+- `15501` is a Pull Request that has been only opened for `0.31`, with no active backport to `0.30`.
+- `15201` is a Pull Request that has only been backported to `0.30`
+- `15181` is a Pull Request that has not been backported, or the automated backport script failed
+- We do not displayed a merged backport Pull Request.
+
+If you want to address a PR only for a specific version, you open the Pull Request for that version, then you can add `no-backport` label for the Pull Request that you do not want to backport to the oldest version.
+
+If a Pull Request is fully backported (merged backport Pull Requests in `0.31` and `0.30` versions), then the line will not be displayed.
+
+=== decidim-backporter
+
+As previously mentioned, we have an automated tool that will try to add create the backports automatically, but sometimes, due to conflicts the automated backport is not possible, so you need to use the `decidim-backporter` command.
+
+[source, bash]
+----
 Usage:
   decidim-backporter --github-token=GITHUB_TOKEN --pull-request-id=PULL_REQUEST_ID --version-number=VERSION_NUMBER
 
 Options:
-  --github-token=GITHUB_TOKEN                                        # Required. GitHub Personal Access Token (PAT). It can be obtained from https://github.com/settings/tokens/new. You will need to create one with `public_repo` access.
-  --version-number=VERSION_NUMBER                                    # Required. The version number that you want to do the backport to. It must have the format MAJOR.MINOR.
-  --pull-request-id=PULL_REQUEST_ID                                  # Required. The ID of the pull request that you want to make the backport from. It should have the "type: fix" label.
-  [--exit-with-unstaged-changes], [--no-exit-with-unstaged-changes]  # Optional. Whether the script should exit with an error if there are unstaged changes in the current project.
-                                                                     # Default: true
+  --github-token=GITHUB_TOKEN                                                                             # Required. Github Personal Access Token (PAT). It can be obtained from https://github.com/settings/tokens/new. You will need to create one with `public_repo` access.
+Alternatively, you can use the `gh` CLI tool to authenticate with `gh auth token` (i.e. --github-token=$(gh auth token))
+  --version-number=VERSION_NUMBER                                                                         # Required. The version number that you want to do the backport to. It must have the format MAJOR.MINOR.
+  --pull-request-id=PULL_REQUEST_ID                                                                       # Required. The ID of the pull request that you want to make the backport from. It should have the "type: fix" label.
+  [--exit-with-unstaged-changes], [--no-exit-with-unstaged-changes], [--skip-exit-with-unstaged-changes]  # Optional. Whether the script should exit with an error if there are unstaged changes in the current project.
+                                                                                                          # Default: true
+  [--with-console], [--no-with-console], [--skip-with-console]                                            # Optional. Disables the shell dropout
+                                                                                                          # Default: true
 
 Backport a pull request to another branch
-```
+----
+
+An example of the command is:
+
+[source, bash]
+----
+decidim-backporter --github-token=$(gh auth token) --pull-request-id=1234 --version-number=0.31
+----
+
+In this particular example, 1234 is the Pull Request merged against develop branch, while `--version-number` is the version where we want to backport.
+We do not need to pass the full version, as this will apply the fix only for the unreleased versions, regardless if we are on `0.31.0.rc1`, `0.31.0` or `0.31.1`
+
+The command will attempt to apply the patch, and if the patch fails with error, a console will be displayed, allowing you to change the files in your editor. After the conflict is fixed, you will need to write the following in your console:
+[source, bash]
+----
+git add <any conflicting files that you fixed>
+git cherry-pick --continue
+# type logout or press CTRL + D
+----
+
+The process will continue creating the backport Pull Request.
+
+If you want to skip the backport creation for any reason, you just need to ensure that when your console drops, you do not have staged / modified files. Typing a `git cherry-pick --abort` will clean the backport process. After that you just need to exit the console with either `logout` or `CTRL+D`.