Kódtároló-integrációk¶
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.
Telepítési áttekintés¶
Adjon hozzáférést a Weblate-nek a tárolóhoz.
A Hosted Weblate esetén adja hozzá a weblate felhasználót, ha elérhető, lásd: Tárolók elérése a Hosted Weblate szolgáltatásból.
For self-hosted Weblate, create a dedicated code hosting user and grant access using Weblate’s SSH key or an HTTPS token, see Tárolók elérése kódtároló szolgáltatásokon (GitHub, GitLab, Bitbucket, Azure DevOps, …).
Configure Forráskód tároló 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 Hookok engedélyezése enabled.
Decide how Weblate should push translations back:
Use Git or Mercurial and Tároló feltöltési URL 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 Feltöltési ág when Weblate should push to a branch in the upstream repository instead of using a fork where supported.
Változások feltöltése Weblate-ből¶
Each translation component can have a push URL set up (see Tároló feltöltési URL), 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 Feltöltés véglegesítéskor (Push on commit).
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 módosítási kérelmek (pull request), GitLab egyesítési kérelmek (merge request), Gitea módosítási kérelmek (pull request), Pagure egyesítési kérelmek (merge request), Azure DevOps egyesítési kérelmek (pull request), or Gerrit review requests reviews. You can activate these by choosing GitHub, GitLab, Gitea, Gerrit, Azure DevOps, or Pagure as Verziókezelő rendszer in Összetevőkonfiguráció.
Overall, following options are available with Git, Mercurial, GitHub, GitLab, Gitea, Pagure, Azure DevOps, Gerrit, Bitbucket Data Center and Bitbucket Cloud:
Kívánt beállítás |
|||
|---|---|---|---|
Nincs feltöltés (No push) |
üres |
üres |
|
Közvetlen feltöltés (Push directly) |
SSH URL |
üres |
|
Feltöltés külön ágra (Push to separate branch) |
SSH URL |
Ágnév megadása (Branch name) |
|
Nincs feltöltés (No push) |
üres |
üres |
|
Közvetlen feltöltés (Push directly) |
SSH URL |
üres |
|
GitHub módosítási kérelem külső másolatból (pull request from fork) |
üres |
üres |
|
GitHub módosítási kérelem saját ágról (pull request from branch) |
SSH URL [1] |
Ágnév megadása (Branch name) |
|
GitLab egyesítési kérelem külső másolatból (merge request from fork) |
üres |
üres |
|
GitLab egyesítési kérelem saját ágról (merge request from branch) |
SSH URL [1] |
Ágnév megadása (Branch name) |
|
Gitea egyesítési kérelem külső másolatból (merge request from fork) |
üres |
üres |
|
Gitea egyesítési kérelem saját ágról (merge request from branch) |
SSH URL [1] |
Ágnév megadása (Branch name) |
|
Pagure egyesítési kérelem külső másolatból (merge request from fork) |
üres |
üres |
|
Pagure egyesítési kérelem saját ágról (merge request from branch) |
SSH URL [1] |
Ágnév megadása (Branch name) |
|
Azure DevOps módosítási kérelem külső másolatból (pull request from fork) |
üres |
üres |
|
Azure DevOps módosítási kérelem saját ágról (pull request from branch) |
SSH URL [1] |
Ágnév megadása (Branch name) |
|
Gerrit review |
SSH URL |
Target branch name (optional) |
|
Bitbucket Data Center módosítási kérelem külső másolatból (pull request from fork) |
üres |
üres |
|
Bitbucket Data Center módosítási kérelem saját ágról (pull request from branch) |
SSH URL [1] |
Ágnév megadása (Branch name) |
|
Bitbucket Cloud módosítási kérelem külső másolatból (pull request from fork) |
üres |
üres |
|
Bitbucket Cloud módosítási kérelem saját ágról (pull request from branch) |
SSH URL [1] |
Ágnév megadása (Branch name) |
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 Forráskód tároló.
Configure Tároló feltöltési URL only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Változások feltöltése Weblate-ből.
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.
To use this approach:
Create a personal access token as described in Creating an access token for command-line use.
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 Forráskód tároló,
for example git@example.com:group/project.git.
Configure Tároló feltöltési URL only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Változások feltöltése Weblate-ből.
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 Tárolók elérése a Hosted Weblate szolgáltatásból.
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.
This approach is also used for Hosted Weblate, which has a dedicated weblate user for that purpose.
Megjegyzés
When using GitHub for pull requests, the Feltöltési ág 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¶
A Weblate natív támogatást nyújt a GitHubhoz.
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 Tárolók elérése a Hosted Weblate szolgáltatásból.
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:
A Payload URL (adatküldési URL) a Weblate címe után /hooks/github/ útvonallal bővül, például Hosted Weblate esetén: 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 módosítási kérelmek (pull request)¶
Ez egy vékony réteget ad a Git fölé, a GitHub API segítségével, amely lehetővé teszi, hogy a fordítási változások módosítási kérelemként kerüljenek feltöltésre, ne közvetlenül a tárolóba.
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
Verziókezelő rendszer 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¶
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 Forráskód tároló.
Configure Tároló feltöltési URL only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Változások feltöltése Weblate-ből.
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.
Megjegyzés
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¶
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 Forráskód tároló,
for example git@example.com:group/project.git.
Configure Tároló feltöltési URL only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Változások feltöltése Weblate-ből.
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 Tárolók elérése a Hosted Weblate szolgáltatásból.
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/.
Hibaelhárítás
Check GitLab webhook request history if webhooks are delivered.
The response payload contains information about matched components.
GitLab egyesítési kérelmek (merge request)¶
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
Verziókezelő rendszer and configure GITLAB_CREDENTIALS.
The Feltöltési ág 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¶
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 Forráskód tároló.
Configure Tároló feltöltési URL only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Változások feltöltése Weblate-ből.
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¶
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 Forráskód tároló,
for example git@example.com:group/project.git.
Configure Tároló feltöltési URL only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Változások feltöltése Weblate-ből.
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 Tárolók elérése a Hosted Weblate szolgáltatásból.
For Hosted Weblate repositories on Codeberg, add the hosted weblate user where write access is needed, see Tárolók elérése a Hosted Weblate szolgáltatásból.
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 módosítási kérelmek (pull request)¶
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.
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 Gitea backend creates pull requests.
To create pull requests, select Gitea as
Verziókezelő rendszer and configure GITEA_CREDENTIALS.
Bitbucket¶
Bitbucket repository access¶
HTTPS with an 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 Forráskód tároló.
Configure Tároló feltöltési URL only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Változások feltöltése Weblate-ből.
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¶
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 Forráskód tároló,
for example git@example.com:group/project.git.
Configure Tároló feltöltési URL only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Változások feltöltése Weblate-ből.
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 Tárolók elérése a Hosted Weblate szolgáltatásból.
Hosted Weblate has a dedicated weblate user for Bitbucket access, see Tárolók elérése a Hosted Weblate szolgáltatásból.
To push directly, use Git or Mercurial with Tároló feltöltési URL.
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 módosítási kérelmek (pull request)¶
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.
Figyelem
Ez nem támogatja a Bitbucket Cloud API-t.
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 Bitbucket Data Center backend creates a pull request.
To create pull requests, select Bitbucket Data Center as
Verziókezelő rendszer and configure BITBUCKETSERVER_CREDENTIALS.
Bitbucket Cloud módosítási kérelmek (pull request)¶
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.
Figyelem
Ez eltér a Bitbucket Data Center API-tól.
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 Bitbucket Cloud backend creates a pull request.
To create pull requests, select Bitbucket Cloud as
Verziókezelő rendszer and configure BITBUCKETCLOUD_CREDENTIALS.
Azure DevOps¶
Azure Repos repository access¶
HTTPS with an 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 Forráskód tároló.
Configure Tároló feltöltési URL only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Változások feltöltése Weblate-ből.
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¶
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 Forráskód tároló,
for example git@example.com:group/project.git.
Configure Tároló feltöltési URL only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Változások feltöltése Weblate-ből.
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 Tárolók elérése a Hosted Weblate szolgáltatásból.
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 egyesítési kérelmek (pull request)¶
Ez egy vékony réteget ad a Git fölé, az Azure DevOps API használatával, hogy a fordítási módosításokat közvetlen feltöltés helyett, egyesítési kérelemként lehessen beküldeni.
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
Verziókezelő rendszer and configure AZURE_DEVOPS_CREDENTIALS.
Pagure¶
Pagure repository access¶
HTTPS with an 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 Forráskód tároló.
Configure Tároló feltöltési URL only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Változások feltöltése Weblate-ből.
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¶
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 Forráskód tároló,
for example git@example.com:group/project.git.
Configure Tároló feltöltési URL only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Változások feltöltése Weblate-ből.
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 Tárolók elérése a Hosted Weblate szolgáltatásból.
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 egyesítési kérelmek (merge request)¶
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.
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 Pagure backend creates a merge request.
To create merge requests, select Pagure as
Verziókezelő rendszer and configure PAGURE_CREDENTIALS.
Other workflows¶
Gitee repository access¶
HTTPS with an 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 Forráskód tároló.
Configure Tároló feltöltési URL only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Változások feltöltése Weblate-ből.
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¶
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 Forráskód tároló,
for example git@example.com:group/project.git.
Configure Tároló feltöltési URL only when Weblate should push changes directly or when the chosen workflow requires a push URL, see Változások feltöltése Weblate-ből.
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 Tárolók elérése a Hosted Weblate szolgáltatásból.
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 Feltöltési ág setting selects the target branch for
the Gerrit review. Leave it empty to use Tároló ág. 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 Kódtároló oldalak hitelesítő adatai.