From 97e56bc53a51b6d302a8e52c28b3677884cc8669 Mon Sep 17 00:00:00 2001 From: Andres Almiray Date: Thu, 27 May 2021 22:25:56 +0200 Subject: [PATCH] List integrations at a single location --- docs/antora.yml | 1 + docs/modules/ROOT/nav-integrations.adoc | 1 + docs/modules/ROOT/pages/index.adoc | 13 +++++- docs/modules/ROOT/pages/integrations.adoc | 50 +++++++++++++++++++++++ 4 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 docs/modules/ROOT/nav-integrations.adoc create mode 100644 docs/modules/ROOT/pages/integrations.adoc diff --git a/docs/antora.yml b/docs/antora.yml index a4e1d48..2dff22a 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -14,6 +14,7 @@ nav: - modules/ROOT/nav-workflow.adoc - modules/ROOT/nav-distributions.adoc - modules/ROOT/nav-artifacts.adoc +- modules/ROOT/nav-integrations.adoc - modules/configuration/nav.adoc - modules/templates/nav.adoc - modules/continuous-integration/nav.adoc diff --git a/docs/modules/ROOT/nav-integrations.adoc b/docs/modules/ROOT/nav-integrations.adoc new file mode 100644 index 0000000..380589b --- /dev/null +++ b/docs/modules/ROOT/nav-integrations.adoc @@ -0,0 +1 @@ +* xref:integrations.adoc[] diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index 5dbd757..125c8a1 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -9,7 +9,7 @@ JReleaser takes inputs from popular builds tools (Ant, Maven, Gradle) such as JA (`.zip`, `.tar`), JLink images, or any other file that you'd like to publish as a Git release on popular Git services such as GitHub, GitLab, or Gitea. Distribution files can additionally be published to be consumed by popular package managers as Homebrew, Snapcraft, Scoop, or get ready to be launched via Jbang. Releases may be announced in a variety of channels such -as Twitter, Zulip, SdkMan!, and others. +as Twitter, Zulip, SdkMan!, and others. Have a look at the listed xref:integrations.adoc[integrations]. image::jreleaser-tools.png[] @@ -24,6 +24,17 @@ Once setup, you can create a new release by invoking the `full-release` command. Every step of the release process is configurable. Inputs may be parameterized externally; several input files may be provided as templates. +== Where does it run + +You can run JReleaser at your local development machine or at any of the following CI/CD solutions: +xref:continuous-integration:buddy.adoc[], xref:continuous-integration:buildkite.adoc[], +xref:continuous-integration:circle-ci.adoc[], xref:continuous-integration:cirrus-ci.adoc[], +xref:continuous-integration:codefresh.adoc[], xref:continuous-integration:codeship.adoc[], +xref:continuous-integration:drone.adoc[], xref:continuous-integration:github-actions.adoc[], +xref:continuous-integration:gitlab-ci.adoc[], xref:continuous-integration:jenkins.adoc[], +xref:continuous-integration:teamcity.adoc[], xref:continuous-integration:travis-ci.adoc[]. +More to come in the future. + == How it looks A (moving) picture is worth a thousand words diff --git a/docs/modules/ROOT/pages/integrations.adoc b/docs/modules/ROOT/pages/integrations.adoc new file mode 100644 index 0000000..e5f4403 --- /dev/null +++ b/docs/modules/ROOT/pages/integrations.adoc @@ -0,0 +1,50 @@ += Integrations + +JReleaser provides integrations with the following services and tools: + +== Release + +Releases may be posted to the following services: + + * xref:configuration:release/github.adoc[] + * xref:configuration:release/gitlab.adoc[] + * xref:configuration:release/gitea.adoc[] + * xref:configuration:release/codeberg.adoc[] + * xref:configuration:release/generic.adoc[Generic git] + +IMPORTANT: The `generic` releaser does not support all features. + +== Upload + +Artifacts, checksums, signatures may be uploaded to the following services: + + * xref:configuration:upload/artifactory.adoc[] + * xref:configuration:upload/http.adoc[Generic HTTP/HTTPS] + +== Package & Publish + +xref:distributions/index.adoc[] may be packaged and published with the following tools: + + * xref:configuration:packagers/chocolatey.adoc[] + * xref:configuration:packagers/docker.adoc[] + * xref:configuration:packagers/homebrew.adoc[] + * xref:configuration:packagers/jbang.adoc[] + * xref:configuration:packagers/scoop.adoc[] + * xref:configuration:packagers/snap.adoc[] + +== Announce + +Releases may be announced using the following tools and communication channels: + + * xref:configuration:announce/discord.adoc[] + * xref:configuration:announce/discussions.adoc[] + * xref:configuration:announce/gitter.adoc[] + * xref:configuration:announce/mail.adoc[] + * xref:configuration:announce/mastodon.adoc[] + * xref:configuration:announce/mattermost.adoc[] + * xref:configuration:announce/sdkman.adoc[] + * xref:configuration:announce/slack.adoc[] + * xref:configuration:announce/teams.adoc[] + * xref:configuration:announce/twitter.adoc[] + * xref:configuration:announce/zulip.adoc[] +