Skip to content
Closed
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ htmlcov/
node_modules/
requirements.txt
tagbot.egg-info/
.venv/
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,31 @@ Read on for a full description of all of the available configuration options.

## Basic Configuration Options

### GitLab Support

TagBot also supports repositories hosted on GitLab. To enable GitLab integration,
set the `github`/`github_api` input values to your GitLab instance (for
GitLab.com use `https://gitlab.com`), and provide a personal access token with
the appropriate scopes (API access to read projects and create merge requests).

Example `workflow_dispatch` inputs for GitLab:

```yml
with:
token: ${{ secrets.GITLAB_TOKEN }}
github: https://gitlab.com
github_api: https://gitlab.com
```

Notes:
- `python-gitlab` is required for runtime GitLab support (installed as a
dependency in development or CI). If it is missing and a GitLab URL is
provided, TagBot will raise an informative error.
- The current GitLab integration implements a pragmatic subset of features
(creating merge requests, reading file contents, and listing merge requests)
that map to the PyGithub usage in this project.


### SSH Deploy Keys

Sometimes, instead of using the default `secrets.GITHUB_TOKEN`, it is better to use an SSH deploy key.
Expand Down
1,333 changes: 764 additions & 569 deletions poetry.lock

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ types-PyYAML = "6.0.12.20250822"
setuptools = "^80.9.0"
wheel = "^0.45.1"

[tool.poetry.extras]
gitlab = ["python-gitlab"]
[tool.poetry.dev-dependencies]
black = "^25.1"
boto3 = "^1.40.21"
Expand Down
Loading
Loading