Skip to main content

Python script which will automatically close issues on GitLab for you.

Project description

Pipeline Status PyPI Project License PyPI Project Version Documentation Status


This is a simple Python cli script that allows you close issues on GitLab automatically. It is intended to be used during your CI/CD. However you can chose to use it however you wish.


First you need to create a personal access token, more information here. With the scope api, so it can close the issue for you.

pip install gitlab-auto-close-issue
gitlab_auto_close_issue --help

Usage: gitlab_auto_close_issue [OPTIONS]

  GitLab Auto Close Issue

  --private-token TEXT     Private GITLAB token, used to authenticate when
                          calling the auto issue close API.  [required]
  --project-id INTEGER     The project ID on GitLab to create the auto close API for.
  --gitlab-url TEXT       The GitLab URL.
  -i, --issue TEXT         The Issue ID to close.  [required]
  -r, --remove-label TEXT  The labels to remove from (all) the issue(s) before
                          closing it.
  --help                   Show this message and exit.
$ gitlab_auto_close_issue --private-token xxx  --project-url \
  --project-id 14416075 --issue 1 --remove-label bug

GitLab CI

Set a secret variable in your GitLab project with your private token. Name it GITLAB_PRIVATE_TOKEN (CI/CD > Environment Variables). This is necessary to close the issue on your behalf. More information click here. This access token is passed to the script with the --private-token argument. An example CI using this can be found here, look for the close:issue job.

Add the following to your .gitlab-ci.yml file:

  - post

  stage: post
  before_script: []
    - gitlab_auto_close_issue --issue 1 --remove-label "Doing" --remove-label "To Do"
Predefined Variables

Please note some of the arguments can be filled in using environment variables defined during GitLab CI. For more information click here <>_.

  • If --private-token is not set the script will look for the ENV variable GITLAB_PRIVATE_TOKEN

  • If --source-branch is not set the script will look for the ENV variable CI_COMMIT_REF_NAME

  • If --project-id is not set it will look for for the ENV variable CI_PROJECT_ID

  • If --gitlab-url is not set it will look for for the ENV variable CI_PROJECT_URL

  • If --user-id is not set it will look for for the ENV variable GITLAB_USER_ID

Setup Development Environment

git clone
cd gitlab-auto-close-issue
pip install tox
make virtualenv
make install-dev


You can find the changelog here.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gitlab-auto-close-issue-1.0.0.tar.gz (4.2 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page