Skip to content

Commit ef42523

Browse files
author
Nathan Friend
authored
docs: add note about version compatibility (#246)
* docs: add note about version compatibility * docs: add link to Releases API
1 parent 26d20c1 commit ef42523

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,3 +99,15 @@ distribution` and `MyLibrary CSS distribution` in the GitLab release.
9999
`[['dist/**/*.{js,css}', '!**/*.min.*'], {path: 'build/MyLibrary.zip', label: 'MyLibrary'}]`: include all the `js` and
100100
`css` files in the `dist` directory and its sub-directories excluding the minified version, plus the
101101
`build/MyLibrary.zip` file and label it `MyLibrary` in the GitLab release.
102+
103+
## Compatibility
104+
105+
The latest version of this plugin is compatible with all currently-supported versions of GitLab, [which is the current major version and previous two major versions](https://about.gitlab.com/support/statement-of-support.html#version-support). This plugin is not guaranteed to work with unsupported versions of GitLab.
106+
107+
### Breaking changes in 14.0
108+
109+
If you are using GitLab.com or have upgraded your self-hosted GitLab instance to 14.0, please use version `>=6.0.7` of this plugin.
110+
111+
#### Why?
112+
113+
In GitLab 14.0, creating a release using the [Tags API](https://docs.gitlab.com/ee/api/tags.html) has been removed (see [<span>#</span>290311](https://gitlab.com/gitlab-org/gitlab/-/issues/290311)). This plugin was updated to use the [Releases API](https://docs.gitlab.com/ee/api/releases/#create-a-release) instead in https://github.com/semantic-release/gitlab/pull/184, which is available in version `6.0.7` and beyond.

0 commit comments

Comments
 (0)