diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-11-02 12:09:38 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-11-02 12:09:38 +0300 |
commit | aa84824d04b32ce9cd3abeac90a6bf78fb2be34c (patch) | |
tree | 379dffa10441e382014909ed8a694f1c0c4ec927 /doc | |
parent | 96100bc70c151404efe5d261813131aaf72b0d41 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ci/components/index.md | 33 | ||||
-rw-r--r-- | doc/development/api_graphql_styleguide.md | 6 | ||||
-rw-r--r-- | doc/integration/jira/issues.md | 3 |
3 files changed, 32 insertions, 10 deletions
diff --git a/doc/ci/components/index.md b/doc/ci/components/index.md index 8246e1c4073..9063b6d0378 100644 --- a/doc/ci/components/index.md +++ b/doc/ci/components/index.md @@ -169,19 +169,34 @@ Nesting of components is not possible. For example: ## Release a component -To create a release for a CI/CD component, use either: +To create a release for a CI/CD component, use the [`release`](../yaml/index.md#release) +keyword in a CI/CD pipeline. -- The [`release`](../yaml/index.md#release) keyword in a CI/CD pipeline. Like in the - [component testing example](#test-the-component), you can set a component to automatically - be released after all tests pass in pipelines for new tags. -- The [UI for creating a release](../../user/project/releases/index.md#create-a-release). +For example: + +```yaml +create-release: + stage: deploy + image: registry.gitlab.com/gitlab-org/release-cli:latest + rules: + - if: $CI_COMMIT_TAG =~ /^v\d+/ + script: echo "Creating release $CI_COMMIT_TAG" + release: + tag_name: $CI_COMMIT_TAG + description: "Release $CI_COMMIT_TAG of components repository $CI_PROJECT_PATH" +``` + +In this example, the job runs only for tags formatted as `v` + version number. +If all previous jobs succeed, the release is created. + +Like in the [component testing example](#test-the-component), you can set a component to automatically +be released after all tests pass in pipelines for new tags. -All released versions of the components are displayed in the [CI/CD Catalog](catalog.md) -page for the given resource, providing users with information about official releases. +All released versions of the components repositories are displayed in the [CI/CD Catalog](catalog.md), +providing users with information about official releases. Components [can be used](#use-a-component-in-a-cicd-configuration) without being released, -but only with a commit SHA or a branch name. To enable the use of tags or the `~latest` version keyword, -you must create a release. +by using the commit SHA or ref. However, the `~latest` version keyword can only be used with released tags. ## Use a component in a CI/CD configuration diff --git a/doc/development/api_graphql_styleguide.md b/doc/development/api_graphql_styleguide.md index 3662b21eb9e..bb685c30631 100644 --- a/doc/development/api_graphql_styleguide.md +++ b/doc/development/api_graphql_styleguide.md @@ -154,7 +154,11 @@ developers must familiarize themselves with our [Deprecation and Removal process Breaking changes are: - Removing or renaming a field, argument, enum value, or mutation. -- Changing the type of a field, argument or enum value. +- Changing the type or type name of an argument. This is because the type of an argument + is declared by the client when [using variables](https://graphql.org/learn/queries/#variables), + and queries with the old type name would be rejected by the API. +- Changing the _scalar type_ of a field or enum value. Object types can be changed so long as all + scalar type fields of the object remain the same. - Raising the [complexity](#max-complexity) of a field or complexity multipliers in a resolver. - Changing a field from being _not_ nullable (`null: false`) to nullable (`null: true`), as discussed in [Nullable fields](#nullable-fields). diff --git a/doc/integration/jira/issues.md b/doc/integration/jira/issues.md index ae4b726327c..f6716f49ea5 100644 --- a/doc/integration/jira/issues.md +++ b/doc/integration/jira/issues.md @@ -117,6 +117,9 @@ For example, use any of these trigger words to close the Jira issue `PROJECT-1`: The commit or merge request must target your project's [default branch](../../user/project/repository/branches/default.md). You can change your project's default branch in [project settings](../../user/project/settings/index.md). +When your branch name matches the Jira issue ID, `Closes <JIRA-ID>` is automatically appended to your existing merge request template. +If you do not want to close the issue, [disable automatic issue closing](../../user/project/issues/managing_issues.md#disable-automatic-issue-closing). + ### Use case for closing issues Consider this example: |