Warn users that they should use supported GitLab version
Problem to solve
The extension doesn't work correctly with older GitLab versions (13.4 and older) (e.g. #347 (closed) #358 (closed)). But the users don't have any way of finding this information and so the process currently looks like this:
- GitLab instance returns an error
- User creates a bug in extension issues
- We try to help the user debug the issue
- Eventually we ask about the GitLab version
- User tells us an old version
- We mark the issue as wontfix and explain to the user that we don't support old versions
Proposal
Passive solutions
Passive solutions to the problem are trivial to implement, but they are not going to be as effective, because they rely on user reading the documentation for the extension.
- Add a note to the top of the README, that explains that the extension supports GitLab 13.5 and above.
- Add a section to the Bug issue template
Active solution
- When we start the extension, we can check the
/api/v4/version
response and if we find out that the version is lower than 13.5, we'll show the user a warning saying that they are connected to an unsupported version of GitLab instance and the extension won't fully work.
Further details
- We already make use of the
version
endpoint: https://gitlab.com/gitlab-org/gitlab-vscode-extension/blob/c484feb48d44d8492a54be61b51637c781ef2b53/src/gitlab_service.ts#L170-181
Links / references
/cc @phikai