Document tag skipping

This commit is contained in:
Andres Almiray
2021-03-29 01:19:23 +02:00
parent 1a680089dc
commit d97c4db89d
5 changed files with 55 additions and 4 deletions

1
.gitignore vendored
View File

@@ -10,4 +10,3 @@ target/
.project
tmp/
.DS_Store
local-playbook.yml

11
README.adoc Normal file
View File

@@ -0,0 +1,11 @@
= JReleaser Website
* Install link:https://antora.org/[Antora].
* Generate the site
[source,sh]
----
$ antora local-playbook.yml
----
* Browse to `build/site/index.html`.

View File

@@ -5,9 +5,9 @@ site:
content:
sources:
- url: https://github.com/jreleaser/jreleaser.github.io.git
branches: main
start_path: docs
- url: https://github.com/jreleaser/jreleaser.github.io.git
branches: main
start_path: docs
ui:
bundle:

View File

@@ -62,6 +62,11 @@ release:
# [optional]
allowUploadToExisting: true
# Skips creating a tag.
# Useful when the tag was created externally.
# [optional]
skipTagging: false
# The GitHub API endpoint to use.
# Update it if using GitHub Enterprise.
# Defaults to `pass:[https://api.github.com]`.
@@ -204,6 +209,11 @@ JSON::
// [optional]
"allowUploadToExisting": true,
// Skips creating a tag.
// Useful when the tag was created externally.
// [optional]
"skipTagging": false,
// The GitHub API endpoint to use.
// Update it if using GitHub Enterprise.
// Defaults to `pass:[https://api.github.com]`.
@@ -376,6 +386,13 @@ Maven::
-->
<allowUploadToExisting>true</allowUploadToExisting>
<!--
Skips creating a tag.
Useful when the tag was created externally.
[optional]
-->
<skipTagging>false</skipTagging>
<!--
The GitHub API endpoint to use.
Update it if using GitHub Enterprise.
@@ -552,6 +569,11 @@ jreleaser {
// [optional]
allowUploadToExisting = true
// Skips creating a tag.
// Useful when the tag was created externally.
// [optional]
skipTagging = false
// The GitHub API endpoint to use.
// Update it if using GitHub Enterprise.
// Defaults to `pass:[https://api.github.com]`.

19
local-playbook.yml Normal file
View File

@@ -0,0 +1,19 @@
site:
title: JReleaser
url: https://jreleaser.org
start_page: guide::index.adoc
content:
sources:
- url: ./
branches: main
start_path: docs
ui:
bundle:
url: ui-bundle.zip
supplemental_files: './supplemental_ui'
asciidoc:
extensions:
- ./extensions/tabs-block/extension