From d97c4db89dbd7f8c19297971d4db0a93d16eb3d6 Mon Sep 17 00:00:00 2001 From: Andres Almiray Date: Mon, 29 Mar 2021 01:19:23 +0200 Subject: [PATCH] Document tag skipping --- .gitignore | 1 - README.adoc | 11 ++++++++++ antora-playbook.yml | 6 ++--- .../configuration/pages/release/github.adoc | 22 +++++++++++++++++++ local-playbook.yml | 19 ++++++++++++++++ 5 files changed, 55 insertions(+), 4 deletions(-) create mode 100644 README.adoc create mode 100644 local-playbook.yml diff --git a/.gitignore b/.gitignore index c616398..00dc94f 100644 --- a/.gitignore +++ b/.gitignore @@ -10,4 +10,3 @@ target/ .project tmp/ .DS_Store -local-playbook.yml diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..e8eec0e --- /dev/null +++ b/README.adoc @@ -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`. \ No newline at end of file diff --git a/antora-playbook.yml b/antora-playbook.yml index 9fab965..5d98962 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -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: diff --git a/docs/modules/configuration/pages/release/github.adoc b/docs/modules/configuration/pages/release/github.adoc index 31e7ffe..5b38be3 100644 --- a/docs/modules/configuration/pages/release/github.adoc +++ b/docs/modules/configuration/pages/release/github.adoc @@ -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:: --> true + + false +