Skip to content

Commit

Permalink
[#53434] Incorrect spelling of GitLab module under project settings
Browse files Browse the repository at this point in the history
  • Loading branch information
akabiru committed Mar 18, 2024
1 parent e62148a commit 5bf8bb3
Show file tree
Hide file tree
Showing 73 changed files with 321 additions and 320 deletions.
2 changes: 1 addition & 1 deletion docs/development/development-environment-docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ docker compose --project-directory docker/dev/tls up -d

## GitLab CE Service

Within `docker/dev/gitlab` a compose file is provided for running local Gitlab instance with TLS support. This provides
Within `docker/dev/gitlab` a compose file is provided for running local GitLab instance with TLS support. This provides
a production like environment for testing the OpenProject GitLab integration against a community edition GitLab instance
accessible on `https://gitlab.local`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ group :opf_plugins do
end
```

**Note:** The Gitlab plugin is usually only compatible with the latest versions. For more information, please see the respective repository: https://github.com/btey/openproject-gitlab-integration/
**Note:** The GitLab plugin is usually only compatible with the latest versions. For more information, please see the respective repository: https://github.com/btey/openproject-gitlab-integration/

The group `:opf_plugins` is generally recommended, but only required for plugins with custom frontend code that is picked up by webpack and output into their respective bundles.

Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes/12/12-1-0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ We added a new “Files” tab in the work package details. This way, you will h
- Fixed: Users can't select public template projects in new project dialog \[[#40918](https://community.openproject.org/wp/40918)\]
- Fixed: Meeting Time in iCalendar is wrong \[[#40941](https://community.openproject.org/wp/40941)\]
- Fixed: Toolbar icons should be rendered in the "old" style and not the new rounded style (which is a work in progress) \[[#40957](https://community.openproject.org/wp/40957)\]
- Fixed: [Docker] - Gitlab integration plugin \[[#40959](https://community.openproject.org/wp/40959)\]
- Fixed: [Docker] - GitLab integration plugin \[[#40959](https://community.openproject.org/wp/40959)\]
- Fixed: Project dropdown no longer autofocused \[[#40978](https://community.openproject.org/wp/40978)\]
- Fixed: Not possible to copy work package to another project \[[#41005](https://community.openproject.org/wp/41005)\]
- Fixed: Changed calendar styles applied to time entries component \[[#41013](https://community.openproject.org/wp/41013)\]
Expand Down
21 changes: 11 additions & 10 deletions docs/system-admin-guide/integrations/gitlab-integration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ OpenProject offers an integration with GitLab merge requests to link software de

OpenProject work packages will directly display information from GitLab in a separate tab.

![Gitlab tab in an OpenProject work package](gitlab-tab.png)
![GitLab tab in an OpenProject work package](gitlab-tab.png)

The tab shows all merge requests (MR) linked to a work package with the corresponding status (e.g. 'Ready' or 'Merged') as well as the state (e.g. 'success' or 'queued') of the GitLab actions configured to run for a MR. MRs and work packages are in an n:m relationship, so a work package can be linked to multiple merge requests and a merge request can be linked to multiple work packages.

Expand All @@ -37,7 +37,7 @@ First you will need to create a user in OpenProject that has the permission to m

![GitLab role with required permissions in OpenProject](openproject-system-guide-gitlab-integration-role.png)

This user will then have to be **added to each project** with a role that allows them to see work packages and comment on them.
This user will then have to be **added to each project** with a role that allows them to see work packages and comment on them.

![GitLab user added as member to project with respective role](openproject-system-guide-gitlab-integration-project-member.png)

Expand All @@ -48,15 +48,16 @@ Once the user is created you need to generate an OpenProject API token for this
3. Go to [*Access Tokens*](../../../getting-started/my-account/#access-tokens)
4. Click on **+ API token**

> Make sure you copy the generated key an securely save it, as you will not be able to retrieve it later.
> Make sure you copy the generated key an securely save it, as you will not be able to retrieve it later.
You can then configure the necessary webhook in [GitLab](#gitlab).

Finally you will need to activate the GitLabmodule under [Project settings](../../../user-guide/projects/project-settings/modules/) so that all information pulling through from GitLab will be shown in the work packages.

![Activate a GitLab module in OpenProject](openproject-system-guide-gitlab-integration-project-modules.png)

Seeing the **GitLab** tab requires **Show GitLab content** permission, so this permission needs to be granted to all roles in a project allowed to see the tab.
Seeing the **GitLab** tab requires permission (WHAT PERMISSION? PLEASE UPDATE) so the permission needs to be granted to all roles in a project allowed to see the tab.
Seeing the **GitLab** tab requires **Show GitLab content** permission, so this permission needs to be granted to all roles in a project allowed to see the tab.

### GitLab

Expand Down Expand Up @@ -100,7 +101,7 @@ You can now publish your branch (you can also do this later, after making the ch

With the branch opened, you can start the actual development work using your preferred tool to alter your codebase.

![Gitlab changes in a merge request changes](gitlab-changes.png)
![GitLab changes in a merge request changes](gitlab-changes.png)

Once you are satisfied with the changes you can create a commit. Within the 'Git snippets' menu, OpenProject suggests a commit message for you based on the title and the URL of the work package.

Expand Down Expand Up @@ -138,16 +139,16 @@ If the status of a merge request changes, it will be reflected in the OpenProjec

### Link issues

OpenProject GitLab integration allows linking GitLab issues directly with OpenProject work packages.
OpenProject GitLab integration allows linking GitLab issues directly with OpenProject work packages.

Initially when no issues were linked yet you will see the following message under **GitLab** tab.
Initially when no issues were linked yet you will see the following message under **GitLab** tab.

![](openproject-system-guide-gitlab-integration-no-issues.png)

You can either create a new issue in GitLab, or edit an already existing one. Enter the code **OP#388** into the issue title or description to create the link between the GitLab issue and the OpenProject work package. In this case 388 is the work package ID.
You can either create a new issue in GitLab, or edit an already existing one. Enter the code **OP#388** into the issue title or description to create the link between the GitLab issue and the OpenProject work package. In this case 388 is the work package ID.

![Link a GitLab issue to OpenProject work package](openproject-system-guide-gitlab-integration-gitlab-issue.png)

Once you save your changes or create a GitLab issue, it will become visible under the **GitLab** tab in OpenProject.
Once you save your changes or create a GitLab issue, it will become visible under the **GitLab** tab in OpenProject.

![New GitLab issues shown in OpenProject work packages](openproject-system-guide-gitlab-integration-new-issues.png)
![New GitLab issues shown in OpenProject work packages](openproject-system-guide-gitlab-integration-new-issues.png)
12 changes: 6 additions & 6 deletions modules/gitlab_integration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ If there are labels related to the Issue or MR, a button with the label icon wil
## Overview

OpenProject module for integration with GitLab:
* Latest Gitlab release tested: **16.6.2**
* Latest GitLab release tested: **16.6.2**
* Latest OpenProject release tested: **13.1.2** (for OP v13.0.X use v2.1.2)

The reference system is based on the same system as for GitHub integration. You can use a link to the work package or just use “OP#87” or "PP#87" in the title/description of the Issue/MR in GitLab.
Expand Down Expand Up @@ -136,7 +136,7 @@ A typical workflow on GitLab side would be:
## Configuration

You will have to configure both **OpenProject** and **Gitlab** for the integration to work.
You will have to configure both **OpenProject** and **GitLab** for the integration to work.

In case of **Docker** installation, follow the official OpenProject documentation [here](https://www.openproject.org/docs/installation-and-operations/installation/docker/#openproject-plugins). If for some reason the installation with Docker described in the official documentation does not work for you, you can try building your own docker image:
* Clone from the Openproject Repo: `git clone https://github.com/opf/openproject.git --branch=stable/13 --depth=1 .`
Expand All @@ -151,7 +151,7 @@ In case of [**manual**](https://www.openproject.org/docs/installation-and-operat

- **Github plugin path:** `modules/github_integration`

- **Path to put Gitlab plugin:** `modules/gitlab_integration`
- **Path to put GitLab plugin:** `modules/gitlab_integration`

But first you must modify **Gemfile.lock** and **Gemfile.modules** so that OpenProject detects the new module.

Expand Down Expand Up @@ -198,13 +198,13 @@ bundle config set deployment

First you will need to create a user in OpenProject that will make the comments. The user will have to be added to each project with a role that allows them to comment on work packages and change status.

Once the user is created you need to generate an OpenProject API token for it to use later on the Gitlab side:
Once the user is created you need to generate an OpenProject API token for it to use later on the GitLab side:

* Login as the newly created user.
* Go to My Account (click on Avatar in top right corner).
* Go to Access Token.
* Click on generate in the API row.
* Copy the generated key. You can now configure the necessary webhook in Gitlab.
* Copy the generated key. You can now configure the necessary webhook in GitLab.

### The webhook in GitLab

Expand All @@ -227,7 +227,7 @@ You need to configure just two things in the webhook:

Now the integration is set up on both sides and you can use it.

> **Note:** If you are installing and configuring OpenProject on the same server as GitLab you will need to enable in Gitlab the option [`Allow requests to the local network from web hooks and services`](https://docs.gitlab.com/ee/security/webhooks.html#allow-requests-to-the-local-network-from-webhooks-and-integrations) so that it can send the data locally to the OpenProject webhook since they will be on the same machine.
> **Note:** If you are installing and configuring OpenProject on the same server as GitLab you will need to enable in GitLab the option [`Allow requests to the local network from web hooks and services`](https://docs.gitlab.com/ee/security/webhooks.html#allow-requests-to-the-local-network-from-webhooks-and-integrations) so that it can send the data locally to the OpenProject webhook since they will be on the same machine.
## How to report bugs or issues

Expand Down
4 changes: 2 additions & 2 deletions modules/gitlab_integration/config/locales/crowdin/af.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ af:
attributes:
labels:
invalid_schema: "must be an array of hashes with keys: color, title"
project_module_gitlab: "Gitlab"
permission_show_gitlab_content: "Show Gitlab content"
project_module_gitlab: "GitLab"
permission_show_gitlab_content: "Show GitLab content"
gitlab_integration:
merge_request_opened_comment: >
**MR Opened:** Merge request %{mr_number} [%{mr_title}](%{mr_url}) for [%{repository}](%{repository_url}) has been opened by [%{gitlab_user}](%{gitlab_user_url}).
Expand Down
4 changes: 2 additions & 2 deletions modules/gitlab_integration/config/locales/crowdin/ar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ ar:
attributes:
labels:
invalid_schema: "must be an array of hashes with keys: color, title"
project_module_gitlab: "Gitlab"
permission_show_gitlab_content: "Show Gitlab content"
project_module_gitlab: "GitLab"
permission_show_gitlab_content: "Show GitLab content"
gitlab_integration:
merge_request_opened_comment: >
**MR Opened:** Merge request %{mr_number} [%{mr_title}](%{mr_url}) for [%{repository}](%{repository_url}) has been opened by [%{gitlab_user}](%{gitlab_user_url}).
Expand Down
4 changes: 2 additions & 2 deletions modules/gitlab_integration/config/locales/crowdin/az.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ az:
attributes:
labels:
invalid_schema: "must be an array of hashes with keys: color, title"
project_module_gitlab: "Gitlab"
permission_show_gitlab_content: "Show Gitlab content"
project_module_gitlab: "GitLab"
permission_show_gitlab_content: "Show GitLab content"
gitlab_integration:
merge_request_opened_comment: >
**MR Opened:** Merge request %{mr_number} [%{mr_title}](%{mr_url}) for [%{repository}](%{repository_url}) has been opened by [%{gitlab_user}](%{gitlab_user_url}).
Expand Down
4 changes: 2 additions & 2 deletions modules/gitlab_integration/config/locales/crowdin/be.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ be:
attributes:
labels:
invalid_schema: "must be an array of hashes with keys: color, title"
project_module_gitlab: "Gitlab"
permission_show_gitlab_content: "Show Gitlab content"
project_module_gitlab: "GitLab"
permission_show_gitlab_content: "Show GitLab content"
gitlab_integration:
merge_request_opened_comment: >
**MR Opened:** Merge request %{mr_number} [%{mr_title}](%{mr_url}) for [%{repository}](%{repository_url}) has been opened by [%{gitlab_user}](%{gitlab_user_url}).
Expand Down
4 changes: 2 additions & 2 deletions modules/gitlab_integration/config/locales/crowdin/bg.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ bg:
attributes:
labels:
invalid_schema: "must be an array of hashes with keys: color, title"
project_module_gitlab: "Gitlab"
permission_show_gitlab_content: "Show Gitlab content"
project_module_gitlab: "GitLab"
permission_show_gitlab_content: "Show GitLab content"
gitlab_integration:
merge_request_opened_comment: >
**MR Opened:** Merge request %{mr_number} [%{mr_title}](%{mr_url}) for [%{repository}](%{repository_url}) has been opened by [%{gitlab_user}](%{gitlab_user_url}).
Expand Down
4 changes: 2 additions & 2 deletions modules/gitlab_integration/config/locales/crowdin/ca.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ ca:
attributes:
labels:
invalid_schema: "must be an array of hashes with keys: color, title"
project_module_gitlab: "Gitlab"
permission_show_gitlab_content: "Show Gitlab content"
project_module_gitlab: "GitLab"
permission_show_gitlab_content: "Show GitLab content"
gitlab_integration:
merge_request_opened_comment: >
**MR Opened:** Merge request %{mr_number} [%{mr_title}](%{mr_url}) for [%{repository}](%{repository_url}) has been opened by [%{gitlab_user}](%{gitlab_user_url}).
Expand Down
4 changes: 2 additions & 2 deletions modules/gitlab_integration/config/locales/crowdin/ckb-IR.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ ckb-IR:
attributes:
labels:
invalid_schema: "must be an array of hashes with keys: color, title"
project_module_gitlab: "Gitlab"
permission_show_gitlab_content: "Show Gitlab content"
project_module_gitlab: "GitLab"
permission_show_gitlab_content: "Show GitLab content"
gitlab_integration:
merge_request_opened_comment: >
**MR Opened:** Merge request %{mr_number} [%{mr_title}](%{mr_url}) for [%{repository}](%{repository_url}) has been opened by [%{gitlab_user}](%{gitlab_user_url}).
Expand Down
4 changes: 2 additions & 2 deletions modules/gitlab_integration/config/locales/crowdin/cs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ cs:
attributes:
labels:
invalid_schema: "must be an array of hashes with keys: color, title"
project_module_gitlab: "Gitlab"
permission_show_gitlab_content: "Show Gitlab content"
project_module_gitlab: "GitLab"
permission_show_gitlab_content: "Show GitLab content"
gitlab_integration:
merge_request_opened_comment: >
**MR Opened:** Merge request %{mr_number} [%{mr_title}](%{mr_url}) for [%{repository}](%{repository_url}) has been opened by [%{gitlab_user}](%{gitlab_user_url}).
Expand Down
4 changes: 2 additions & 2 deletions modules/gitlab_integration/config/locales/crowdin/da.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ da:
attributes:
labels:
invalid_schema: "must be an array of hashes with keys: color, title"
project_module_gitlab: "Gitlab"
permission_show_gitlab_content: "Show Gitlab content"
project_module_gitlab: "GitLab"
permission_show_gitlab_content: "Show GitLab content"
gitlab_integration:
merge_request_opened_comment: >
**MR Opened:** Merge request %{mr_number} [%{mr_title}](%{mr_url}) for [%{repository}](%{repository_url}) has been opened by [%{gitlab_user}](%{gitlab_user_url}).
Expand Down
4 changes: 2 additions & 2 deletions modules/gitlab_integration/config/locales/crowdin/de.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ de:
attributes:
labels:
invalid_schema: "must be an array of hashes with keys: color, title"
project_module_gitlab: "Gitlab"
permission_show_gitlab_content: "Show Gitlab content"
project_module_gitlab: "GitLab"
permission_show_gitlab_content: "Show GitLab content"
gitlab_integration:
merge_request_opened_comment: >
**MR Opened:** Merge request %{mr_number} [%{mr_title}](%{mr_url}) for [%{repository}](%{repository_url}) has been opened by [%{gitlab_user}](%{gitlab_user_url}).
Expand Down
4 changes: 2 additions & 2 deletions modules/gitlab_integration/config/locales/crowdin/el.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ el:
attributes:
labels:
invalid_schema: "must be an array of hashes with keys: color, title"
project_module_gitlab: "Gitlab"
permission_show_gitlab_content: "Show Gitlab content"
project_module_gitlab: "GitLab"
permission_show_gitlab_content: "Show GitLab content"
gitlab_integration:
merge_request_opened_comment: >
**MR Opened:** Merge request %{mr_number} [%{mr_title}](%{mr_url}) for [%{repository}](%{repository_url}) has been opened by [%{gitlab_user}](%{gitlab_user_url}).
Expand Down
4 changes: 2 additions & 2 deletions modules/gitlab_integration/config/locales/crowdin/eo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ eo:
attributes:
labels:
invalid_schema: "must be an array of hashes with keys: color, title"
project_module_gitlab: "Gitlab"
permission_show_gitlab_content: "Show Gitlab content"
project_module_gitlab: "GitLab"
permission_show_gitlab_content: "Show GitLab content"
gitlab_integration:
merge_request_opened_comment: >
**MR Opened:** Merge request %{mr_number} [%{mr_title}](%{mr_url}) for [%{repository}](%{repository_url}) has been opened by [%{gitlab_user}](%{gitlab_user_url}).
Expand Down
4 changes: 2 additions & 2 deletions modules/gitlab_integration/config/locales/crowdin/es.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ es:
attributes:
labels:
invalid_schema: "must be an array of hashes with keys: color, title"
project_module_gitlab: "Gitlab"
permission_show_gitlab_content: "Show Gitlab content"
project_module_gitlab: "GitLab"
permission_show_gitlab_content: "Show GitLab content"
gitlab_integration:
merge_request_opened_comment: >
**MR Opened:** Merge request %{mr_number} [%{mr_title}](%{mr_url}) for [%{repository}](%{repository_url}) has been opened by [%{gitlab_user}](%{gitlab_user_url}).
Expand Down
4 changes: 2 additions & 2 deletions modules/gitlab_integration/config/locales/crowdin/et.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ et:
attributes:
labels:
invalid_schema: "must be an array of hashes with keys: color, title"
project_module_gitlab: "Gitlab"
permission_show_gitlab_content: "Show Gitlab content"
project_module_gitlab: "GitLab"
permission_show_gitlab_content: "Show GitLab content"
gitlab_integration:
merge_request_opened_comment: >
**MR Opened:** Merge request %{mr_number} [%{mr_title}](%{mr_url}) for [%{repository}](%{repository_url}) has been opened by [%{gitlab_user}](%{gitlab_user_url}).
Expand Down
4 changes: 2 additions & 2 deletions modules/gitlab_integration/config/locales/crowdin/eu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ eu:
attributes:
labels:
invalid_schema: "must be an array of hashes with keys: color, title"
project_module_gitlab: "Gitlab"
permission_show_gitlab_content: "Show Gitlab content"
project_module_gitlab: "GitLab"
permission_show_gitlab_content: "Show GitLab content"
gitlab_integration:
merge_request_opened_comment: >
**MR Opened:** Merge request %{mr_number} [%{mr_title}](%{mr_url}) for [%{repository}](%{repository_url}) has been opened by [%{gitlab_user}](%{gitlab_user_url}).
Expand Down
4 changes: 2 additions & 2 deletions modules/gitlab_integration/config/locales/crowdin/fa.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ fa:
attributes:
labels:
invalid_schema: "must be an array of hashes with keys: color, title"
project_module_gitlab: "Gitlab"
permission_show_gitlab_content: "Show Gitlab content"
project_module_gitlab: "GitLab"
permission_show_gitlab_content: "Show GitLab content"
gitlab_integration:
merge_request_opened_comment: >
**MR Opened:** Merge request %{mr_number} [%{mr_title}](%{mr_url}) for [%{repository}](%{repository_url}) has been opened by [%{gitlab_user}](%{gitlab_user_url}).
Expand Down
4 changes: 2 additions & 2 deletions modules/gitlab_integration/config/locales/crowdin/fi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ fi:
attributes:
labels:
invalid_schema: "must be an array of hashes with keys: color, title"
project_module_gitlab: "Gitlab"
permission_show_gitlab_content: "Show Gitlab content"
project_module_gitlab: "GitLab"
permission_show_gitlab_content: "Show GitLab content"
gitlab_integration:
merge_request_opened_comment: >
**MR Opened:** Merge request %{mr_number} [%{mr_title}](%{mr_url}) for [%{repository}](%{repository_url}) has been opened by [%{gitlab_user}](%{gitlab_user_url}).
Expand Down
Loading

0 comments on commit 5bf8bb3

Please sign in to comment.