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 Mengakses repositori dari 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 Mengakses repositori di situs pengehosan kode (GitHub, GitLab, Bitbucket, Azure DevOps, ...).
Configure Repositori kode sumber 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 Aktifkan pengait enabled.
Decide how Weblate should push translations back:
- Use Git or Mercurial and URL dorong repositori 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 Cabang dorong when Weblate should push to a branch in the upstream repository instead of using a fork where supported.

Mendorong perubahan dari Weblate¶

Each translation component can have a push URL set up (see URL dorong repositori), 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 Dorong dalam komit.

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 Permintaan tarik GitHub, Permintaan penggabungan GitLab, Permintaan tarik Gitea, Permintaan penggabungan Pagure, Permintaan penarikan Azure DevOps, or Gerrit review requests reviews. You can activate these by choosing GitHub, GitLab, Gitea, Gerrit, Azure DevOps, or Pagure as Sistem kontrol versi in Konfigurasi komponen.

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

Pengaturan yang diinginkan	Sistem kontrol versi	URL dorong repositori	Cabang dorong
Tidak ada dorongan	Git	kosong	kosong
Dorong langsung	Git	URL SSH	kosong
Dorong untuk memisahkan cabang	Git	URL SSH	Nama cabang
Tidak ada dorongan	Mercurial	kosong	kosong
Dorong langsung	Mercurial	URL SSH	kosong
Permintaan tarik GitHub dari fork	Permintaan tarik GitHub	kosong	kosong
Permintaan tarik GitHub dari cabang	Permintaan tarik GitHub	URL SSH [1]	Nama cabang
Permintaan penggabungan GitLab dari fork	Permintaan penggabungan GitLab	kosong	kosong
Permintaan penggabungan GitLab dari cabang	Permintaan penggabungan GitLab	URL SSH [1]	Nama cabang
Permintaan penggabungan Gitea dari fork	Permintaan tarik Gitea	kosong	kosong
Permintaan penggabungan Gitea dari cabang	Permintaan tarik Gitea	URL SSH [1]	Nama cabang
Permintaan penggabungan Pagure dari fork	Permintaan penggabungan Pagure	kosong	kosong
Permintaan penggabungan Pagure dari cabang	Permintaan penggabungan Pagure	URL SSH [1]	Nama cabang
Permintaan tarik Azure DevOps dari fork	Permintaan penarikan Azure DevOps	kosong	kosong
Permintaan tarik Azure DevOps dari cabang	Permintaan penarikan Azure DevOps	URL SSH [1]	Nama cabang
Gerrit review	Gerrit review requests	URL SSH	Target branch name (optional)
Permintaan tarik Bitbucket Data Center dari fork	Permintaan penarikan Bitbucket Data Center	kosong	kosong
Permintaan tarik Bitbucket Data Center dari cabang	Permintaan penarikan Bitbucket Data Center	URL SSH [1]	Nama cabang
Permintaan tarik Bitbucket Cloud dari fork	Permintaan penarikan Bitbucket Cloud	kosong	kosong
Permintaan tarik Bitbucket Cloud dari cabang	Permintaan penarikan Bitbucket Cloud	URL SSH [1]	Nama cabang

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 Repositori kode sumber.

Configure URL dorong repositori only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Mendorong perubahan dari 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.

Untuk menggunakan pendekatan ini:

Buat token akses pribadi seperti yang dijelaskan dalam Membuat token akses untuk penggunaan baris perintah.
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 Repositori kode sumber, for example git@example.com:group/project.git.

Configure URL dorong repositori only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Mendorong perubahan dari Weblate.

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 Mengakses repositori dari 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.

Pendekatan ini juga digunakan untuk Hosted Weblate, yang memiliki pengguna weblate khusus untuk tujuan tersebut.

Catatan

When using GitHub for pull requests, the Cabang dorong 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 dilengkapi dengan dukungan asli untuk 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 Mengakses repositori dari 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:

URL Payload terdiri dari URL Weblate Anda yang ditambahkan oleh /hooks/github/, misalnya untuk layanan Hosted Weblate, ini adalah 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.

Lihat juga

Permintaan tarik GitHub¶

Ini menambahkan lapisan tipis di atas Git menggunakan GitHub API untuk memungkinkan mendorong perubahan terjemahan sebagai permintaan tarik, alih-alih mendorong langsung ke repositori.

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 Sistem kontrol versi 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¶

Configure URL dorong repositori only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Mendorong perubahan dari 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.

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.

Catatan

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¶

Configure URL dorong repositori only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Mendorong perubahan dari Weblate.

On Hosted Weblate, use the hosted weblate user on supported code hosting sites, see Mengakses repositori dari 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/.

Pemecahan masalah

Periksa riwayat permintaan webhook GitLab apakah kait web terkirim.
Muatan respons berisi informasi tentang komponen yang cocok.

Lihat juga

Permintaan penggabungan 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 Sistem kontrol versi and configure GITLAB_CREDENTIALS.

The Cabang dorong 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¶

Configure URL dorong repositori only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Mendorong perubahan dari 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.

SSH with a dedicated user¶

Configure URL dorong repositori only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Mendorong perubahan dari Weblate.

On Hosted Weblate, use the hosted weblate user on supported code hosting sites, see Mengakses repositori dari Hosted Weblate.

For Hosted Weblate repositories on Codeberg, add the hosted weblate user where write access is needed, see Mengakses repositori dari 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.

Lihat juga

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.

Lihat juga

Permintaan tarik 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 Sistem kontrol versi and configure GITEA_CREDENTIALS.

Bitbucket¶

Bitbucket repository access¶

HTTPS with an access token¶

Configure URL dorong repositori only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Mendorong perubahan dari 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.

SSH with a dedicated user¶

Configure URL dorong repositori only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Mendorong perubahan dari Weblate.

On Hosted Weblate, use the hosted weblate user on supported code hosting sites, see Mengakses repositori dari Hosted Weblate.

Hosted Weblate has a dedicated weblate user for Bitbucket access, see Mengakses repositori dari Hosted Weblate.

To push directly, use Git or Mercurial with URL dorong repositori.

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/.

Lihat juga

Permintaan penarikan 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.

Peringatan

Ini tidak mendukung API Bitbucket Cloud.

To create pull requests, select Bitbucket Data Center as Sistem kontrol versi and configure BITBUCKETSERVER_CREDENTIALS.

Permintaan penarikan 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.

Peringatan

Ini berbeda dari API Bitbucket Data Center.

To create pull requests, select Bitbucket Cloud as Sistem kontrol versi and configure BITBUCKETCLOUD_CREDENTIALS.

Azure DevOps¶

Azure Repos repository access¶

HTTPS with an access token¶

Configure URL dorong repositori only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Mendorong perubahan dari 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.

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

SSH with a dedicated user¶

Configure URL dorong repositori only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Mendorong perubahan dari Weblate.

On Hosted Weblate, use the hosted weblate user on supported code hosting sites, see Mengakses repositori dari 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.

Lihat juga

Permintaan penarikan Azure DevOps¶

Ini menambahkan lapisan tipis di atas Git menggunakan Azure DevOps API untuk memungkinkan mendorong perubahan terjemahan sebagai permintaan tarik, alih-alih mendorong langsung ke repositori.

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 Sistem kontrol versi and configure AZURE_DEVOPS_CREDENTIALS.

Pagure¶

Pagure repository access¶

HTTPS with an access token¶

Configure URL dorong repositori only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Mendorong perubahan dari 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.

SSH with a dedicated user¶

Configure URL dorong repositori only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Mendorong perubahan dari Weblate.

On Hosted Weblate, use the hosted weblate user on supported code hosting sites, see Mengakses repositori dari 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:

Lihat juga

Permintaan penggabungan 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 Sistem kontrol versi and configure PAGURE_CREDENTIALS.

Other workflows¶

Gitee repository access¶

HTTPS with an access token¶

Configure URL dorong repositori only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Mendorong perubahan dari 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.

SSH with a dedicated user¶

Configure URL dorong repositori only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Mendorong perubahan dari Weblate.

On Hosted Weblate, use the hosted weblate user on supported code hosting sites, see Mengakses repositori dari 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.

Lihat juga

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 Cabang dorong setting selects the target branch for the Gerrit review. Leave it empty to use Cabang repositori. 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 Kredensial situs pengehosan kode.