Code hosting integrations¶

Weblate integrates with code hosting sites in several separate places: repository access, incoming notifications, and pushing translations back. The exact setup depends on whether you use Hosted Weblate or run your own Weblate instance, and on whether Weblate should push directly or create pull requests.

Use this page as a provider-oriented checklist. The individual setting pages remain the canonical reference for setting syntax.

Setup overview¶

Grant Weblate access to the repository.
- For Hosted Weblate, add the hosted weblate user where it is available, see Доступ до сховищ з Hosted Weblate.
- For self-hosted Weblate, create a dedicated code hosting user and grant access using Weblate’s SSH key or an HTTPS token, see Доступ до сховищ на сайтах зберігання коду (GitHub, GitLab, Bitbucket, Azure DevOps, …).
Configure Сховище з джерелами so Weblate can clone the repository.
Configure incoming notifications so Weblate pulls changes soon after a push. The repository webhook or app must point to the matching Weblate hook URL, and the project must have Увімкнути обробники enabled.
Decide how Weblate should push translations back:
- Use Git or Mercurial and Адреса для записування до сховища to push directly.
- Use a provider-specific VCS backend, such as GitHub or GitLab, to create pull or merge requests. These backends need API credentials in the Weblate settings.
Optionally set Гілка для запису when Weblate should push to a branch in the upstream repository instead of using a fork where supported.

Записування змін з Weblate¶

Each translation component can have a push URL set up (see Адреса для записування до сховища), and in that case Weblate will be able to push changes to the remote repository. Weblate can also be configured to automatically push changes on every commit; this is enabled by default, see Відправляти при поданні.

If you do not want changes to be pushed automatically, you can push manually under Repository maintenance or using the API via wlc push.

In case you do not want direct pushes by Weblate, there is support for Запити щодо злиття GitHub, Запити щодо об’єднання GitLab, Запити щодо злиття Gitea, Запити щодо об’єднання Pagure, Запити щодо об’єднання Azure DevOps, or Gerrit review requests reviews. You can activate these by choosing GitHub, GitLab, Gitea, Gerrit, Azure DevOps, or Pagure as Система керування версіями in Налаштовування складників.

Overall, following options are available with Git, Mercurial, GitHub, GitLab, Gitea, Pagure, Azure DevOps, Gerrit, Bitbucket Data Center and Bitbucket Cloud:

Бажане налаштування	Система керування версіями	Адреса для записування до сховища	Гілка для запису
Без запису	Git	empty	empty
Записувати безпосередньо	Git	Адреса SSH	empty
Записувати до окремої гілки	Git	Адреса SSH	Назва гілки
Без запису	Mercurial	empty	empty
Записувати безпосередньо	Mercurial	Адреса SSH	empty
Запит щодо об’єднання у GitHub з відгалуження	Запити щодо злиття GitHub	empty	empty
Запит щодо об’єднання у GitHub з гілки	Запити щодо злиття GitHub	SSH URL [1]	Назва гілки
Запит щодо злиття на GitLab з відгалуження	Запити щодо об’єднання GitLab	empty	empty
Запит щодо злиття на GitLab з гілки	Запити щодо об’єднання GitLab	SSH URL [1]	Назва гілки
Запит щодо злиття на Gitea з відгалуження	Запити щодо злиття Gitea	empty	empty
Запит щодо злиття на Gitea з гілки	Запити щодо злиття Gitea	SSH URL [1]	Назва гілки
Запит щодо злиття на Pagure з відгалуження	Запити щодо об’єднання Pagure	empty	empty
Запит щодо злиття на Pagure з гілки	Запити щодо об’єднання Pagure	SSH URL [1]	Назва гілки
Запит щодо об’єднання з відгалуження Azure DevOps	Запити щодо об’єднання Azure DevOps	empty	empty
Запит на злиття Azure DevOps з гілки	Запити щодо об’єднання Azure DevOps	SSH URL [1]	Назва гілки
Gerrit review	Gerrit review requests	Адреса SSH	Target branch name (optional)
Запит на отримання запиту Bitbucket Data Center із форка	Запити на вилучення Bitbucket Data Center	empty	empty
Запит на злиття з Bitbucket Data Center з гілки	Запити на вилучення Bitbucket Data Center	SSH URL [1]	Назва гілки
Запити щодо об’єднання Bitbucket Cloud з відгалуження	Запити щодо об’єднання Bitbucket Cloud	empty	empty
Запити щодо об’єднання Bitbucket Cloud з гілки	Запити щодо об’єднання Bitbucket Cloud	SSH URL [1]	Назва гілки

GitHub¶

GitHub repository access¶

HTTPS with personal access token¶

For a single private repository, HTTPS access with an access token is usually the simplest setup when the provider supports Git over HTTPS. Use the provider-required username and token in Сховище з джерелами.

Configure Адреса для записування до сховища only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Записування змін з Weblate.

The token needs read access for cloning and write access for pushing. Provider-specific VCS backends that create pull or merge requests might require separate API credentials.

Щоб скористатися цим підходом:

Створіть персональний токен доступу, як описано в розділі Створення токена доступу для використання в командному рядку.
Include the token in your repository URL: https://username:token@github.com/owner/repo.git.

This is suitable when you are starting with Weblate or working with a single repository.

SSH with a dedicated user¶

For setups with multiple repositories, use SSH access with a dedicated code hosting user for Weblate. Add Weblate’s public SSH key to that user, grant the user access to the repositories, and use SSH URLs in Сховище з джерелами, for example git@example.com:group/project.git.

This also avoids provider restrictions on SSH key reuse. Some code hosting sites allow a public SSH key to be added only once, or only to a single user or deploy key entry. Keeping Weblate’s SSH key on a dedicated user lets that user be granted access to multiple repositories without reusing the key in several places.

This keeps personal, project, or API access tokens out of repository URLs. Provider API credentials are still needed when using a provider-specific VCS backend to create pull or merge requests; those credentials are configured separately from the Git repository URL.

On Hosted Weblate, use the hosted weblate user on supported code hosting sites, see Доступ до сховищ з Hosted Weblate.

For GitHub, create a dedicated user, for example weblate-bot, and use GitHub SSH URLs for your repositories, for example git@github.com:owner/repo.git.

Цей підхід також використовується для Hosted Weblate, який має спеціального користувача weblate для цієї мети.

Примітка

When using GitHub for pull requests, the Гілка для запису configuration affects the behavior: if not set, the project is forked and changes are pushed through a fork. If set, changes are pushed to the upstream repository and the chosen branch.

GitHub notifications¶

Weblate постачається із вбудованою підтримкою GitHub.

If you are using Hosted Weblate, the recommended approach is to install the Weblate app. The app delivers GitHub notifications to Hosted Weblate, so you do not need to configure a separate Webhook in GitHub. However, it does not by itself grant Hosted Weblate write access to the repository. To push changes back, you still need to add the Hosted Weblate weblate GitHub user as a collaborator with write access, see Доступ до сховищ з Hosted Weblate.

If you are not using the app, add the Weblate webhook in the repository settings (Webhooks) to receive notifications on every push to a GitHub repository, as shown on the image below:

Payload URL складається з вашої URL-адреси Weblate, яко передує /hooks/github/, наприклад, для служби Hosted Weblate — це https://hosted.weblate.org/hooks/github/.

You can leave other values at default settings. Weblate can handle both content types and consumes just the push event.

Дивись також

Запити щодо злиття GitHub¶

Це додає тонкий шар над Git з використанням інструмента GitHub API, щоб уможливити запис змін у перекладах як запитів щодо об’єднання, замість безпосереднього запису до сховища.

Git pushes changes directly to a repository, while the GitHub backend creates pull requests. The latter is not needed for merely accessing Git repositories.

To create pull requests, select GitHub as Система керування версіями and configure GITHUB_CREDENTIALS. For GitHub.com, use api.github.com as the API host. The token must allow Weblate to read and write repository contents and create pull requests. If Weblate should fork private repositories, the token might also need administration access.

GitLab¶

GitLab repository access¶

HTTPS with personal or project access token¶

The token needs read access for cloning and write access for pushing. Provider-specific VCS backends that create pull or merge requests might require separate API credentials.

For GitLab, the token needs write_repository scope to be able to push changes to the repository. The project access token requires Developer role for pushing.

The URL needs to contain a username. For a personal access token, it is the actual username: https://user:personal_access_token@gitlab.com/example/example.git. For project access tokens it can be a non-blank value: https://example:project_access_token@gitlab.com/example/example.git.

Примітка

The rules for using project access tokens have changed between GitLab releases, the non-blank value is the current requirement, but older versions had different expectations (project name, bot user name). Check GitLab documentation matching your version if unsure.

SSH with a dedicated user¶

On Hosted Weblate, use the hosted weblate user on supported code hosting sites, see Доступ до сховищ з Hosted Weblate.

For GitLab, create a dedicated user and use GitLab SSH URLs, for example git@gitlab.com:group/project.git.

GitLab notifications¶

Weblate has support for GitLab hooks. Add a project webhook with destination to /hooks/gitlab/ URL on your Weblate installation, for example https://hosted.weblate.org/hooks/gitlab/.

Вирішення проблем

Перевірте історію запитів вебхуків GitLab, якщо вебхуки доставлені.
Корисне навантаження відповіді містить інформацію про збігаючі компоненти.

Дивись також

Запити щодо об’єднання GitLab¶

This adds a thin layer atop Git using the GitLab API to allow pushing translation changes as merge requests instead of pushing directly to the repository.

There is no need to use this to access Git repositories, ordinary Git works the same, the only difference is how pushing to a repository is handled. With Git changes are pushed directly to the repository, while the GitLab backend creates a merge request.

To create merge requests, select GitLab as Система керування версіями and configure GITLAB_CREDENTIALS.

The Гілка для запису configuration affects where Weblate pushes changes before opening the merge request. If it is not set, the project is forked and changes are pushed through a fork. If it is set, changes are pushed to the upstream repository and chosen branch.

Gitea, Forgejo, and Codeberg¶

Gitea, Forgejo, and Codeberg repository access¶

HTTPS with an access token¶

The token needs read access for cloning and write access for pushing. Provider-specific VCS backends that create pull or merge requests might require separate API credentials.

SSH with a dedicated user¶

On Hosted Weblate, use the hosted weblate user on supported code hosting sites, see Доступ до сховищ з Hosted Weblate.

For Hosted Weblate repositories on Codeberg, add the hosted weblate user where write access is needed, see Доступ до сховищ з Hosted Weblate.

Gitea notifications¶

Weblate has support for Gitea webhooks. Add a Gitea Webhook for Push events event with destination to /hooks/gitea/ URL on your Weblate installation, for example https://hosted.weblate.org/hooks/gitea/. This can be done in Webhooks under repository Settings.

Дивись також

Forgejo notifications¶

Weblate has support for Forgejo webhooks. Add a Forgejo Webhook for Push events event with destination to /hooks/forgejo/ URL on your Weblate installation, for example https://hosted.weblate.org/hooks/forgejo/. This can be done in Webhooks under repository Settings.

Дивись також

Запити щодо злиття Gitea¶

Added in version 4.12.

This adds a thin layer atop Git using the Gitea API to allow pushing translation changes as pull requests instead of pushing directly to the repository.

To create pull requests, select Gitea as Система керування версіями and configure GITEA_CREDENTIALS.

Bitbucket¶

Bitbucket repository access¶

HTTPS with an access token¶

The token needs read access for cloning and write access for pushing. Provider-specific VCS backends that create pull or merge requests might require separate API credentials.

SSH with a dedicated user¶

On Hosted Weblate, use the hosted weblate user on supported code hosting sites, see Доступ до сховищ з Hosted Weblate.

Hosted Weblate has a dedicated weblate user for Bitbucket access, see Доступ до сховищ з Hosted Weblate.

To push directly, use Git or Mercurial with Адреса для записування до сховища.

Bitbucket notifications¶

Weblate has support for Bitbucket webhooks. Add a webhook which triggers upon repository push, with destination to /hooks/bitbucket/ URL on your Weblate installation, for example https://hosted.weblate.org/hooks/bitbucket/.

Дивись також

Запити на вилучення Bitbucket Data Center¶

Added in version 4.16.

This adds a thin layer atop Git using the Bitbucket Data Center API to allow pushing translation changes as pull requests instead of pushing directly to the repository.

Попередження

Тут не передбачено підтримки хмарного програмного інтерфейсу Bitbucket.

To create pull requests, select Bitbucket Data Center as Система керування версіями and configure BITBUCKETSERVER_CREDENTIALS.

Запити щодо об’єднання Bitbucket Cloud¶

Added in version 5.8.

This adds a thin layer atop Git using the Bitbucket Cloud API to allow pushing translation changes as pull requests instead of pushing directly to the repository.

Попередження

Це відрізняється від Bitbucket Data Center API.

To create pull requests, select Bitbucket Cloud as Система керування версіями and configure BITBUCKETCLOUD_CREDENTIALS.

Azure DevOps¶

Azure Repos repository access¶

HTTPS with an access token¶

The token needs read access for cloning and write access for pushing. Provider-specific VCS backends that create pull or merge requests might require separate API credentials.

Use the HTTPS clone URL shown by Azure Repos for the repository.

SSH with a dedicated user¶

On Hosted Weblate, use the hosted weblate user on supported code hosting sites, see Доступ до сховищ з Hosted Weblate.

Use the SSH URL shown by Azure Repos for the repository.

Azure Repos notifications¶

Weblate has support for Azure Repos webhooks. Add a webhook for Code pushed event with destination to /hooks/azure/ URL on your Weblate installation, for example https://hosted.weblate.org/hooks/azure/. This can be done in Service hooks under Project settings.

Дивись також

Запити щодо об’єднання Azure DevOps¶

Це додає тонкий шар над Git з використанням інструмента Azure DevOps API, щоб уможливити запис змін у перекладах як запитів щодо об’єднання, замість безпосереднього запису до сховища.

Git pushes changes directly to a repository, while the Azure DevOps backend creates pull requests. The latter is not needed for merely accessing Git repositories.

To create pull requests, select Azure DevOps as Система керування версіями and configure AZURE_DEVOPS_CREDENTIALS.

Pagure¶

Pagure repository access¶

HTTPS with an access token¶

The token needs read access for cloning and write access for pushing. Provider-specific VCS backends that create pull or merge requests might require separate API credentials.

SSH with a dedicated user¶

On Hosted Weblate, use the hosted weblate user on supported code hosting sites, see Доступ до сховищ з Hosted Weblate.

Pagure notifications¶

Weblate has support for Pagure hooks. Add a webhook with destination to /hooks/pagure/ URL on your Weblate installation, for example https://hosted.weblate.org/hooks/pagure/. This can be done in Activate Web-hooks under Project options:

Дивись також

Запити щодо об’єднання Pagure¶

Added in version 4.3.2.

This adds a thin layer atop Git using the Pagure API to allow pushing translation changes as merge requests instead of pushing directly to the repository.

To create merge requests, select Pagure as Система керування версіями and configure PAGURE_CREDENTIALS.

Other workflows¶

Gitee repository access¶

HTTPS with an access token¶

The token needs read access for cloning and write access for pushing. Provider-specific VCS backends that create pull or merge requests might require separate API credentials.

SSH with a dedicated user¶

On Hosted Weblate, use the hosted weblate user on supported code hosting sites, see Доступ до сховищ з Hosted Weblate.

Gitee notifications¶

Weblate has support for Gitee webhooks. Add a WebHook for Push event with destination to /hooks/gitee/ URL on your Weblate installation, for example https://hosted.weblate.org/hooks/gitee/. This can be done in WebHooks under repository Management.

Дивись також

Gerrit review requests¶

Gerrit support adds a thin layer atop Git using the git-review tool to allow pushing translation changes as Gerrit review requests, instead of pushing them directly to the repository.

The optional Гілка для запису setting selects the target branch for the Gerrit review. Leave it empty to use Гілка сховища. Use the short branch name, such as main; Weblate and git-review push the review to refs/for/<branch> automatically. Gerrit push options can be appended after % in either setting, for example main%topic=l10n. Gerrit interprets these options as the configured Weblate Gerrit account and applies its own permissions.

The Gerrit documentation has the details on the configuration necessary to set up such repositories. There is no separate code hosting credential setting for this backend.

Docker credentials¶

For Docker installations, code hosting API credentials can also be provided through environment variables, see Реєстраційні дані сайтів, де зберігається код.