From aabb1785a48bc93c127aa0b1dce197d3bdc71cc2 Mon Sep 17 00:00:00 2001 From: Lars Kappert Date: Fri, 2 Apr 2021 13:39:11 -0300 Subject: [PATCH] Add "Update release" section to GitLab docs --- docs/github-releases.md | 2 +- docs/gitlab-releases.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/github-releases.md b/docs/github-releases.md index 0067f001..b810275d 100644 --- a/docs/github-releases.md +++ b/docs/github-releases.md @@ -100,7 +100,7 @@ status. - Use `--no-npm` to skip publishing to npm if there's a `package.json`. Use the other options to update the release, such as `--github.assets` to add assets. Note that the `draft` and -`prerelease` options are `false` by default, but can be set explicitly using e.g. `--no-github.draft` or +`preRelease` options are `false` by default, but can be set explicitly using e.g. `--no-github.draft` or `--github.draft`. Example command to add assets and explicitly toggle the draft status to "published": diff --git a/docs/gitlab-releases.md b/docs/gitlab-releases.md index 1d701ea7..48897854 100644 --- a/docs/gitlab-releases.md +++ b/docs/gitlab-releases.md @@ -59,3 +59,19 @@ download from the project's releases page. Example: The `origin` can be set to a string such as `"http://example.org:3000"` to use a different origin from what would be derived from the Git url (e.g. to use `http` over the default `https://${repo.host}`). + +## Update the latest release + +The latest GitLab release can be updated, e.g. to update the releases notes or add release assets. + +- Use `--no-increment` to skip updating the version. +- Use `--no-git` to skip Git actions. +- Use `--no-npm` to skip publishing to npm if there's a `package.json`. + +Use the other options to update the release, such as `--gitlab.assets` to add assets. + +Example command to add assets to the latest release: + +```bash +release-it --no-increment --no-git --gitlab.release --gitlab.assets=*.zip +```