From e6972772be6699035dee2ab3e20e30f28db13ea1 Mon Sep 17 00:00:00 2001 From: Ryan Baxter <524254+ryanjbaxter@users.noreply.github.com> Date: Thu, 9 May 2024 13:22:54 -0400 Subject: [PATCH] Add new code to sync antora docs --- .../src/main/resources/application.yml | 4 + .../projects/spring-docs-actions/.gitignore | 16 ++ .../spring-docs-actions/git/COMMIT_EDITMSG | 1 + .../projects/spring-docs-actions/git/HEAD | 1 + .../projects/spring-docs-actions/git/config | 7 + .../spring-docs-actions/git/description | 1 + .../git/hooks/applypatch-msg.sample | 15 ++ .../git/hooks/commit-msg.sample | 24 +++ .../git/hooks/fsmonitor-watchman.sample | 174 ++++++++++++++++++ .../git/hooks/post-update.sample | 8 + .../git/hooks/pre-applypatch.sample | 14 ++ .../git/hooks/pre-commit.sample | 49 +++++ .../git/hooks/pre-merge-commit.sample | 13 ++ .../git/hooks/pre-push.sample | 53 ++++++ .../git/hooks/pre-rebase.sample | 169 +++++++++++++++++ .../git/hooks/pre-receive.sample | 24 +++ .../git/hooks/prepare-commit-msg.sample | 42 +++++ .../git/hooks/push-to-checkout.sample | 78 ++++++++ .../git/hooks/sendemail-validate.sample | 77 ++++++++ .../git/hooks/update.sample | 128 +++++++++++++ .../projects/spring-docs-actions/git/index | Bin 0 -> 324 bytes .../spring-docs-actions/git/info/exclude | 6 + .../spring-docs-actions/git/logs/HEAD | 4 + .../git/logs/refs/heads/main | 4 + .../0d/0095113b5be7f4fcdfc972268318ec902c5f13 | 2 + .../0d/65649266e723e7033103f9b6ae757ec6580057 | 2 + .../0f/5f2470dfcc0e605318d3559a527b90d3200f4d | Bin 0 -> 46 bytes .../18/c66e805702c81fc2099cb09d2490f099581f34 | 1 + .../19/3a7a691db1f7529bbd1d7f7f4947209622486c | 1 + .../31/914a902c49e2929047e4d716ea82715c6c403f | Bin 0 -> 54 bytes .../35/1ea40513b59a752d40d50fd5e5fc303a6d8e3a | Bin 0 -> 54 bytes .../5b/13c12d6cbaae95d5c70435559222c9e531d9a5 | Bin 0 -> 104 bytes .../64/cdce59318eb9c6b81014c4fe0339ab48bbbbc2 | Bin 0 -> 103 bytes .../6f/646e4b35f6aa83ed6d70b74a0d50f7681cb5cd | Bin 0 -> 73 bytes .../75/5f221a5212015576ede283e6a0f3ce477c238f | Bin 0 -> 156 bytes .../88/9850e6e4256269c906a85b252073b9b71deb1d | Bin 0 -> 88 bytes .../8d/b262c5ba9b96d3a26a5e2b133f131194e4f915 | Bin 0 -> 115 bytes .../91/e848d9a61fd19a78000bc9ac424d1295276f68 | Bin 0 -> 48 bytes .../a3/ffcc384822decb6bc5599bb29a74bbf22dc45e | 2 + .../ae/f837338280bc8fe836d413402a84ec43a712fe | Bin 0 -> 103 bytes .../b7/3656050139102621603351260c98d73f1c7288 | Bin 0 -> 45 bytes .../bb/4e47ec1aa0b5a2dec0ede431ed10577f98c7ef | Bin 0 -> 54 bytes .../c1/eb48842df92c8f185796de35a43f789363eeab | Bin 0 -> 157 bytes .../c7/c3fa38fd33170e7fbb15541066ebe746ba1ad6 | 1 + .../d7/cd2a877e4a6950d6a496bcd3d2be5ab6ca6724 | Bin 0 -> 45 bytes .../spring-docs-actions/git/refs/heads/main | 1 + .../spring-docs-actions/git/refs/tags/v0.0.16 | 1 + .../rsync-antora-reference/src/action.sh | 4 + .../main/java/releaser/internal/Releaser.java | 21 ++- .../releaser/internal/ReleaserProperties.java | 79 +++++++- .../java/releaser/internal/git/GitRepo.java | 15 ++ .../internal/git/ProjectGitHandler.java | 32 +++- .../project/ProjectCommandExecutor.java | 34 ++++ .../tasks/release/PublishDocsReleaseTask.java | 5 +- .../internal/buildsystem/TestUtils.java | 1 + .../releaser/internal/spring/ArgsBuilder.java | 4 + 56 files changed, 1105 insertions(+), 13 deletions(-) create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/.gitignore create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/COMMIT_EDITMSG create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/HEAD create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/config create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/description create mode 100755 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/applypatch-msg.sample create mode 100755 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/commit-msg.sample create mode 100755 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/fsmonitor-watchman.sample create mode 100755 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/post-update.sample create mode 100755 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-applypatch.sample create mode 100755 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-commit.sample create mode 100755 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-merge-commit.sample create mode 100755 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-push.sample create mode 100755 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-rebase.sample create mode 100755 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-receive.sample create mode 100755 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/prepare-commit-msg.sample create mode 100755 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/push-to-checkout.sample create mode 100755 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/sendemail-validate.sample create mode 100755 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/update.sample create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/index create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/info/exclude create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/logs/HEAD create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/logs/refs/heads/main create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/0d/0095113b5be7f4fcdfc972268318ec902c5f13 create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/0d/65649266e723e7033103f9b6ae757ec6580057 create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/0f/5f2470dfcc0e605318d3559a527b90d3200f4d create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/18/c66e805702c81fc2099cb09d2490f099581f34 create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/19/3a7a691db1f7529bbd1d7f7f4947209622486c create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/31/914a902c49e2929047e4d716ea82715c6c403f create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/35/1ea40513b59a752d40d50fd5e5fc303a6d8e3a create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/5b/13c12d6cbaae95d5c70435559222c9e531d9a5 create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/64/cdce59318eb9c6b81014c4fe0339ab48bbbbc2 create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/6f/646e4b35f6aa83ed6d70b74a0d50f7681cb5cd create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/75/5f221a5212015576ede283e6a0f3ce477c238f create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/88/9850e6e4256269c906a85b252073b9b71deb1d create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/8d/b262c5ba9b96d3a26a5e2b133f131194e4f915 create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/91/e848d9a61fd19a78000bc9ac424d1295276f68 create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/a3/ffcc384822decb6bc5599bb29a74bbf22dc45e create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/ae/f837338280bc8fe836d413402a84ec43a712fe create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/b7/3656050139102621603351260c98d73f1c7288 create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/bb/4e47ec1aa0b5a2dec0ede431ed10577f98c7ef create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/c1/eb48842df92c8f185796de35a43f789363eeab create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/c7/c3fa38fd33170e7fbb15541066ebe746ba1ad6 create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/d7/cd2a877e4a6950d6a496bcd3d2be5ab6ca6724 create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/refs/heads/main create mode 100644 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/refs/tags/v0.0.16 create mode 100755 projects/spring-cloud/src/test/resources/projects/spring-docs-actions/rsync-antora-reference/src/action.sh diff --git a/projects/spring-cloud/src/main/resources/application.yml b/projects/spring-cloud/src/main/resources/application.yml index c840cfdd..5c43ef3a 100644 --- a/projects/spring-cloud/src/main/resources/application.yml +++ b/projects/spring-cloud/src/main/resources/application.yml @@ -101,6 +101,10 @@ releaser: all-versions-file-url: https://raw.githubusercontent.com/spring-io/start.spring.io/main/start-site/src/main/resources/application.yml bom-name: spring-cloud # fixed-versions: + antora: + spring-docs-actions-url: https://github.com/spring-io/spring-doc-actions + spring-docs-actions-tag: v0.0.16 + sync-antora-docs-command: "./rsync-antora-reference/src/action.sh" meta-release: enabled: false release-train-project-name: spring-cloud-release diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/.gitignore b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/.gitignore new file mode 100644 index 00000000..8db262c5 --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/.gitignore @@ -0,0 +1,16 @@ +*~ +#* +*# +.#* +.classpath +.project +.settings/ +.springBeans +target/ +_site/ +.idea +*.iml +*.ipr +.factorypath +*.swp +/consul \ No newline at end of file diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/COMMIT_EDITMSG b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/COMMIT_EDITMSG new file mode 100644 index 00000000..0406423b --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/COMMIT_EDITMSG @@ -0,0 +1 @@ +updating action diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/HEAD b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/HEAD new file mode 100644 index 00000000..b870d826 --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/HEAD @@ -0,0 +1 @@ +ref: refs/heads/main diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/config b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/config new file mode 100644 index 00000000..6c9406b7 --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/config @@ -0,0 +1,7 @@ +[core] + repositoryformatversion = 0 + filemode = true + bare = false + logallrefupdates = true + ignorecase = true + precomposeunicode = true diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/description b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/description new file mode 100644 index 00000000..498b267a --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/description @@ -0,0 +1 @@ +Unnamed repository; edit this file 'description' to name the repository. diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/applypatch-msg.sample b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/applypatch-msg.sample new file mode 100755 index 00000000..a5d7b84a --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/applypatch-msg.sample @@ -0,0 +1,15 @@ +#!/bin/sh +# +# An example hook script to check the commit log message taken by +# applypatch from an e-mail message. +# +# The hook should exit with non-zero status after issuing an +# appropriate message if it wants to stop the commit. The hook is +# allowed to edit the commit message file. +# +# To enable this hook, rename this file to "applypatch-msg". + +. git-sh-setup +commitmsg="$(git rev-parse --git-path hooks/commit-msg)" +test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"} +: diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/commit-msg.sample b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/commit-msg.sample new file mode 100755 index 00000000..b58d1184 --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/commit-msg.sample @@ -0,0 +1,24 @@ +#!/bin/sh +# +# An example hook script to check the commit log message. +# Called by "git commit" with one argument, the name of the file +# that has the commit message. The hook should exit with non-zero +# status after issuing an appropriate message if it wants to stop the +# commit. The hook is allowed to edit the commit message file. +# +# To enable this hook, rename this file to "commit-msg". + +# Uncomment the below to add a Signed-off-by line to the message. +# Doing this in a hook is a bad idea in general, but the prepare-commit-msg +# hook is more suited to it. +# +# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') +# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1" + +# This example catches duplicate Signed-off-by lines. + +test "" = "$(grep '^Signed-off-by: ' "$1" | + sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || { + echo >&2 Duplicate Signed-off-by lines. + exit 1 +} diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/fsmonitor-watchman.sample b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/fsmonitor-watchman.sample new file mode 100755 index 00000000..23e856f5 --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/fsmonitor-watchman.sample @@ -0,0 +1,174 @@ +#!/usr/bin/perl + +use strict; +use warnings; +use IPC::Open2; + +# An example hook script to integrate Watchman +# (https://facebook.github.io/watchman/) with git to speed up detecting +# new and modified files. +# +# The hook is passed a version (currently 2) and last update token +# formatted as a string and outputs to stdout a new update token and +# all files that have been modified since the update token. Paths must +# be relative to the root of the working tree and separated by a single NUL. +# +# To enable this hook, rename this file to "query-watchman" and set +# 'git config core.fsmonitor .git/hooks/query-watchman' +# +my ($version, $last_update_token) = @ARGV; + +# Uncomment for debugging +# print STDERR "$0 $version $last_update_token\n"; + +# Check the hook interface version +if ($version ne 2) { + die "Unsupported query-fsmonitor hook version '$version'.\n" . + "Falling back to scanning...\n"; +} + +my $git_work_tree = get_working_dir(); + +my $retry = 1; + +my $json_pkg; +eval { + require JSON::XS; + $json_pkg = "JSON::XS"; + 1; +} or do { + require JSON::PP; + $json_pkg = "JSON::PP"; +}; + +launch_watchman(); + +sub launch_watchman { + my $o = watchman_query(); + if (is_work_tree_watched($o)) { + output_result($o->{clock}, @{$o->{files}}); + } +} + +sub output_result { + my ($clockid, @files) = @_; + + # Uncomment for debugging watchman output + # open (my $fh, ">", ".git/watchman-output.out"); + # binmode $fh, ":utf8"; + # print $fh "$clockid\n@files\n"; + # close $fh; + + binmode STDOUT, ":utf8"; + print $clockid; + print "\0"; + local $, = "\0"; + print @files; +} + +sub watchman_clock { + my $response = qx/watchman clock "$git_work_tree"/; + die "Failed to get clock id on '$git_work_tree'.\n" . + "Falling back to scanning...\n" if $? != 0; + + return $json_pkg->new->utf8->decode($response); +} + +sub watchman_query { + my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty') + or die "open2() failed: $!\n" . + "Falling back to scanning...\n"; + + # In the query expression below we're asking for names of files that + # changed since $last_update_token but not from the .git folder. + # + # To accomplish this, we're using the "since" generator to use the + # recency index to select candidate nodes and "fields" to limit the + # output to file names only. Then we're using the "expression" term to + # further constrain the results. + my $last_update_line = ""; + if (substr($last_update_token, 0, 1) eq "c") { + $last_update_token = "\"$last_update_token\""; + $last_update_line = qq[\n"since": $last_update_token,]; + } + my $query = <<" END"; + ["query", "$git_work_tree", {$last_update_line + "fields": ["name"], + "expression": ["not", ["dirname", ".git"]] + }] + END + + # Uncomment for debugging the watchman query + # open (my $fh, ">", ".git/watchman-query.json"); + # print $fh $query; + # close $fh; + + print CHLD_IN $query; + close CHLD_IN; + my $response = do {local $/; }; + + # Uncomment for debugging the watch response + # open ($fh, ">", ".git/watchman-response.json"); + # print $fh $response; + # close $fh; + + die "Watchman: command returned no output.\n" . + "Falling back to scanning...\n" if $response eq ""; + die "Watchman: command returned invalid output: $response\n" . + "Falling back to scanning...\n" unless $response =~ /^\{/; + + return $json_pkg->new->utf8->decode($response); +} + +sub is_work_tree_watched { + my ($output) = @_; + my $error = $output->{error}; + if ($retry > 0 and $error and $error =~ m/unable to resolve root .* directory (.*) is not watched/) { + $retry--; + my $response = qx/watchman watch "$git_work_tree"/; + die "Failed to make watchman watch '$git_work_tree'.\n" . + "Falling back to scanning...\n" if $? != 0; + $output = $json_pkg->new->utf8->decode($response); + $error = $output->{error}; + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + # Uncomment for debugging watchman output + # open (my $fh, ">", ".git/watchman-output.out"); + # close $fh; + + # Watchman will always return all files on the first query so + # return the fast "everything is dirty" flag to git and do the + # Watchman query just to get it over with now so we won't pay + # the cost in git to look up each individual file. + my $o = watchman_clock(); + $error = $output->{error}; + + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + output_result($o->{clock}, ("/")); + $last_update_token = $o->{clock}; + + eval { launch_watchman() }; + return 0; + } + + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + return 1; +} + +sub get_working_dir { + my $working_dir; + if ($^O =~ 'msys' || $^O =~ 'cygwin') { + $working_dir = Win32::GetCwd(); + $working_dir =~ tr/\\/\//; + } else { + require Cwd; + $working_dir = Cwd::cwd(); + } + + return $working_dir; +} diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/post-update.sample b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/post-update.sample new file mode 100755 index 00000000..ec17ec19 --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/post-update.sample @@ -0,0 +1,8 @@ +#!/bin/sh +# +# An example hook script to prepare a packed repository for use over +# dumb transports. +# +# To enable this hook, rename this file to "post-update". + +exec git update-server-info diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-applypatch.sample b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-applypatch.sample new file mode 100755 index 00000000..4142082b --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-applypatch.sample @@ -0,0 +1,14 @@ +#!/bin/sh +# +# An example hook script to verify what is about to be committed +# by applypatch from an e-mail message. +# +# The hook should exit with non-zero status after issuing an +# appropriate message if it wants to stop the commit. +# +# To enable this hook, rename this file to "pre-applypatch". + +. git-sh-setup +precommit="$(git rev-parse --git-path hooks/pre-commit)" +test -x "$precommit" && exec "$precommit" ${1+"$@"} +: diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-commit.sample b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-commit.sample new file mode 100755 index 00000000..29ed5ee4 --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-commit.sample @@ -0,0 +1,49 @@ +#!/bin/sh +# +# An example hook script to verify what is about to be committed. +# Called by "git commit" with no arguments. The hook should +# exit with non-zero status after issuing an appropriate message if +# it wants to stop the commit. +# +# To enable this hook, rename this file to "pre-commit". + +if git rev-parse --verify HEAD >/dev/null 2>&1 +then + against=HEAD +else + # Initial commit: diff against an empty tree object + against=$(git hash-object -t tree /dev/null) +fi + +# If you want to allow non-ASCII filenames set this variable to true. +allownonascii=$(git config --type=bool hooks.allownonascii) + +# Redirect output to stderr. +exec 1>&2 + +# Cross platform projects tend to avoid non-ASCII filenames; prevent +# them from being added to the repository. We exploit the fact that the +# printable range starts at the space character and ends with tilde. +if [ "$allownonascii" != "true" ] && + # Note that the use of brackets around a tr range is ok here, (it's + # even required, for portability to Solaris 10's /usr/bin/tr), since + # the square bracket bytes happen to fall in the designated range. + test $(git diff-index --cached --name-only --diff-filter=A -z $against | + LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0 +then + cat <<\EOF +Error: Attempt to add a non-ASCII file name. + +This can cause problems if you want to work with people on other platforms. + +To be portable it is advisable to rename the file. + +If you know what you are doing you can disable this check using: + + git config hooks.allownonascii true +EOF + exit 1 +fi + +# If there are whitespace errors, print the offending file names and fail. +exec git diff-index --check --cached $against -- diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-merge-commit.sample b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-merge-commit.sample new file mode 100755 index 00000000..399eab19 --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-merge-commit.sample @@ -0,0 +1,13 @@ +#!/bin/sh +# +# An example hook script to verify what is about to be committed. +# Called by "git merge" with no arguments. The hook should +# exit with non-zero status after issuing an appropriate message to +# stderr if it wants to stop the merge commit. +# +# To enable this hook, rename this file to "pre-merge-commit". + +. git-sh-setup +test -x "$GIT_DIR/hooks/pre-commit" && + exec "$GIT_DIR/hooks/pre-commit" +: diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-push.sample b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-push.sample new file mode 100755 index 00000000..4ce688d3 --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-push.sample @@ -0,0 +1,53 @@ +#!/bin/sh + +# An example hook script to verify what is about to be pushed. Called by "git +# push" after it has checked the remote status, but before anything has been +# pushed. If this script exits with a non-zero status nothing will be pushed. +# +# This hook is called with the following parameters: +# +# $1 -- Name of the remote to which the push is being done +# $2 -- URL to which the push is being done +# +# If pushing without using a named remote those arguments will be equal. +# +# Information about the commits which are being pushed is supplied as lines to +# the standard input in the form: +# +# +# +# This sample shows how to prevent push of commits where the log message starts +# with "WIP" (work in progress). + +remote="$1" +url="$2" + +zero=$(git hash-object --stdin &2 "Found WIP commit in $local_ref, not pushing" + exit 1 + fi + fi +done + +exit 0 diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-rebase.sample b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-rebase.sample new file mode 100755 index 00000000..6cbef5c3 --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-rebase.sample @@ -0,0 +1,169 @@ +#!/bin/sh +# +# Copyright (c) 2006, 2008 Junio C Hamano +# +# The "pre-rebase" hook is run just before "git rebase" starts doing +# its job, and can prevent the command from running by exiting with +# non-zero status. +# +# The hook is called with the following parameters: +# +# $1 -- the upstream the series was forked from. +# $2 -- the branch being rebased (or empty when rebasing the current branch). +# +# This sample shows how to prevent topic branches that are already +# merged to 'next' branch from getting rebased, because allowing it +# would result in rebasing already published history. + +publish=next +basebranch="$1" +if test "$#" = 2 +then + topic="refs/heads/$2" +else + topic=`git symbolic-ref HEAD` || + exit 0 ;# we do not interrupt rebasing detached HEAD +fi + +case "$topic" in +refs/heads/??/*) + ;; +*) + exit 0 ;# we do not interrupt others. + ;; +esac + +# Now we are dealing with a topic branch being rebased +# on top of master. Is it OK to rebase it? + +# Does the topic really exist? +git show-ref -q "$topic" || { + echo >&2 "No such branch $topic" + exit 1 +} + +# Is topic fully merged to master? +not_in_master=`git rev-list --pretty=oneline ^master "$topic"` +if test -z "$not_in_master" +then + echo >&2 "$topic is fully merged to master; better remove it." + exit 1 ;# we could allow it, but there is no point. +fi + +# Is topic ever merged to next? If so you should not be rebasing it. +only_next_1=`git rev-list ^master "^$topic" ${publish} | sort` +only_next_2=`git rev-list ^master ${publish} | sort` +if test "$only_next_1" = "$only_next_2" +then + not_in_topic=`git rev-list "^$topic" master` + if test -z "$not_in_topic" + then + echo >&2 "$topic is already up to date with master" + exit 1 ;# we could allow it, but there is no point. + else + exit 0 + fi +else + not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"` + /usr/bin/perl -e ' + my $topic = $ARGV[0]; + my $msg = "* $topic has commits already merged to public branch:\n"; + my (%not_in_next) = map { + /^([0-9a-f]+) /; + ($1 => 1); + } split(/\n/, $ARGV[1]); + for my $elem (map { + /^([0-9a-f]+) (.*)$/; + [$1 => $2]; + } split(/\n/, $ARGV[2])) { + if (!exists $not_in_next{$elem->[0]}) { + if ($msg) { + print STDERR $msg; + undef $msg; + } + print STDERR " $elem->[1]\n"; + } + } + ' "$topic" "$not_in_next" "$not_in_master" + exit 1 +fi + +<<\DOC_END + +This sample hook safeguards topic branches that have been +published from being rewound. + +The workflow assumed here is: + + * Once a topic branch forks from "master", "master" is never + merged into it again (either directly or indirectly). + + * Once a topic branch is fully cooked and merged into "master", + it is deleted. If you need to build on top of it to correct + earlier mistakes, a new topic branch is created by forking at + the tip of the "master". This is not strictly necessary, but + it makes it easier to keep your history simple. + + * Whenever you need to test or publish your changes to topic + branches, merge them into "next" branch. + +The script, being an example, hardcodes the publish branch name +to be "next", but it is trivial to make it configurable via +$GIT_DIR/config mechanism. + +With this workflow, you would want to know: + +(1) ... if a topic branch has ever been merged to "next". Young + topic branches can have stupid mistakes you would rather + clean up before publishing, and things that have not been + merged into other branches can be easily rebased without + affecting other people. But once it is published, you would + not want to rewind it. + +(2) ... if a topic branch has been fully merged to "master". + Then you can delete it. More importantly, you should not + build on top of it -- other people may already want to + change things related to the topic as patches against your + "master", so if you need further changes, it is better to + fork the topic (perhaps with the same name) afresh from the + tip of "master". + +Let's look at this example: + + o---o---o---o---o---o---o---o---o---o "next" + / / / / + / a---a---b A / / + / / / / + / / c---c---c---c B / + / / / \ / + / / / b---b C \ / + / / / / \ / + ---o---o---o---o---o---o---o---o---o---o---o "master" + + +A, B and C are topic branches. + + * A has one fix since it was merged up to "next". + + * B has finished. It has been fully merged up to "master" and "next", + and is ready to be deleted. + + * C has not merged to "next" at all. + +We would want to allow C to be rebased, refuse A, and encourage +B to be deleted. + +To compute (1): + + git rev-list ^master ^topic next + git rev-list ^master next + + if these match, topic has not merged in next at all. + +To compute (2): + + git rev-list master..topic + + if this is empty, it is fully merged to "master". + +DOC_END diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-receive.sample b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-receive.sample new file mode 100755 index 00000000..a1fd29ec --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/pre-receive.sample @@ -0,0 +1,24 @@ +#!/bin/sh +# +# An example hook script to make use of push options. +# The example simply echoes all push options that start with 'echoback=' +# and rejects all pushes when the "reject" push option is used. +# +# To enable this hook, rename this file to "pre-receive". + +if test -n "$GIT_PUSH_OPTION_COUNT" +then + i=0 + while test "$i" -lt "$GIT_PUSH_OPTION_COUNT" + do + eval "value=\$GIT_PUSH_OPTION_$i" + case "$value" in + echoback=*) + echo "echo from the pre-receive-hook: ${value#*=}" >&2 + ;; + reject) + exit 1 + esac + i=$((i + 1)) + done +fi diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/prepare-commit-msg.sample b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/prepare-commit-msg.sample new file mode 100755 index 00000000..10fa14c5 --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/prepare-commit-msg.sample @@ -0,0 +1,42 @@ +#!/bin/sh +# +# An example hook script to prepare the commit log message. +# Called by "git commit" with the name of the file that has the +# commit message, followed by the description of the commit +# message's source. The hook's purpose is to edit the commit +# message file. If the hook fails with a non-zero status, +# the commit is aborted. +# +# To enable this hook, rename this file to "prepare-commit-msg". + +# This hook includes three examples. The first one removes the +# "# Please enter the commit message..." help message. +# +# The second includes the output of "git diff --name-status -r" +# into the message, just before the "git status" output. It is +# commented because it doesn't cope with --amend or with squashed +# commits. +# +# The third example adds a Signed-off-by line to the message, that can +# still be edited. This is rarely a good idea. + +COMMIT_MSG_FILE=$1 +COMMIT_SOURCE=$2 +SHA1=$3 + +/usr/bin/perl -i.bak -ne 'print unless(m/^. Please enter the commit message/..m/^#$/)' "$COMMIT_MSG_FILE" + +# case "$COMMIT_SOURCE,$SHA1" in +# ,|template,) +# /usr/bin/perl -i.bak -pe ' +# print "\n" . `git diff --cached --name-status -r` +# if /^#/ && $first++ == 0' "$COMMIT_MSG_FILE" ;; +# *) ;; +# esac + +# SOB=$(git var GIT_COMMITTER_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') +# git interpret-trailers --in-place --trailer "$SOB" "$COMMIT_MSG_FILE" +# if test -z "$COMMIT_SOURCE" +# then +# /usr/bin/perl -i.bak -pe 'print "\n" if !$first_line++' "$COMMIT_MSG_FILE" +# fi diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/push-to-checkout.sample b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/push-to-checkout.sample new file mode 100755 index 00000000..af5a0c00 --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/push-to-checkout.sample @@ -0,0 +1,78 @@ +#!/bin/sh + +# An example hook script to update a checked-out tree on a git push. +# +# This hook is invoked by git-receive-pack(1) when it reacts to git +# push and updates reference(s) in its repository, and when the push +# tries to update the branch that is currently checked out and the +# receive.denyCurrentBranch configuration variable is set to +# updateInstead. +# +# By default, such a push is refused if the working tree and the index +# of the remote repository has any difference from the currently +# checked out commit; when both the working tree and the index match +# the current commit, they are updated to match the newly pushed tip +# of the branch. This hook is to be used to override the default +# behaviour; however the code below reimplements the default behaviour +# as a starting point for convenient modification. +# +# The hook receives the commit with which the tip of the current +# branch is going to be updated: +commit=$1 + +# It can exit with a non-zero status to refuse the push (when it does +# so, it must not modify the index or the working tree). +die () { + echo >&2 "$*" + exit 1 +} + +# Or it can make any necessary changes to the working tree and to the +# index to bring them to the desired state when the tip of the current +# branch is updated to the new commit, and exit with a zero status. +# +# For example, the hook can simply run git read-tree -u -m HEAD "$1" +# in order to emulate git fetch that is run in the reverse direction +# with git push, as the two-tree form of git read-tree -u -m is +# essentially the same as git switch or git checkout that switches +# branches while keeping the local changes in the working tree that do +# not interfere with the difference between the branches. + +# The below is a more-or-less exact translation to shell of the C code +# for the default behaviour for git's push-to-checkout hook defined in +# the push_to_deploy() function in builtin/receive-pack.c. +# +# Note that the hook will be executed from the repository directory, +# not from the working tree, so if you want to perform operations on +# the working tree, you will have to adapt your code accordingly, e.g. +# by adding "cd .." or using relative paths. + +if ! git update-index -q --ignore-submodules --refresh +then + die "Up-to-date check failed" +fi + +if ! git diff-files --quiet --ignore-submodules -- +then + die "Working directory has unstaged changes" +fi + +# This is a rough translation of: +# +# head_has_history() ? "HEAD" : EMPTY_TREE_SHA1_HEX +if git cat-file -e HEAD 2>/dev/null +then + head=HEAD +else + head=$(git hash-object -t tree --stdin &2 + exit 1 +} + +unset GIT_DIR GIT_WORK_TREE +cd "$worktree" && + +if grep -q "^diff --git " "$1" +then + validate_patch "$1" +else + validate_cover_letter "$1" +fi && + +if test "$GIT_SENDEMAIL_FILE_COUNTER" = "$GIT_SENDEMAIL_FILE_TOTAL" +then + git config --unset-all sendemail.validateWorktree && + trap 'git worktree remove -ff "$worktree"' EXIT && + validate_series +fi diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/update.sample b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/update.sample new file mode 100755 index 00000000..c4d426bc --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/hooks/update.sample @@ -0,0 +1,128 @@ +#!/bin/sh +# +# An example hook script to block unannotated tags from entering. +# Called by "git receive-pack" with arguments: refname sha1-old sha1-new +# +# To enable this hook, rename this file to "update". +# +# Config +# ------ +# hooks.allowunannotated +# This boolean sets whether unannotated tags will be allowed into the +# repository. By default they won't be. +# hooks.allowdeletetag +# This boolean sets whether deleting tags will be allowed in the +# repository. By default they won't be. +# hooks.allowmodifytag +# This boolean sets whether a tag may be modified after creation. By default +# it won't be. +# hooks.allowdeletebranch +# This boolean sets whether deleting branches will be allowed in the +# repository. By default they won't be. +# hooks.denycreatebranch +# This boolean sets whether remotely creating branches will be denied +# in the repository. By default this is allowed. +# + +# --- Command line +refname="$1" +oldrev="$2" +newrev="$3" + +# --- Safety check +if [ -z "$GIT_DIR" ]; then + echo "Don't run this script from the command line." >&2 + echo " (if you want, you could supply GIT_DIR then run" >&2 + echo " $0 )" >&2 + exit 1 +fi + +if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then + echo "usage: $0 " >&2 + exit 1 +fi + +# --- Config +allowunannotated=$(git config --type=bool hooks.allowunannotated) +allowdeletebranch=$(git config --type=bool hooks.allowdeletebranch) +denycreatebranch=$(git config --type=bool hooks.denycreatebranch) +allowdeletetag=$(git config --type=bool hooks.allowdeletetag) +allowmodifytag=$(git config --type=bool hooks.allowmodifytag) + +# check for no description +projectdesc=$(sed -e '1q' "$GIT_DIR/description") +case "$projectdesc" in +"Unnamed repository"* | "") + echo "*** Project description file hasn't been set" >&2 + exit 1 + ;; +esac + +# --- Check types +# if $newrev is 0000...0000, it's a commit to delete a ref. +zero=$(git hash-object --stdin &2 + echo "*** Use 'git tag [ -a | -s ]' for tags you want to propagate." >&2 + exit 1 + fi + ;; + refs/tags/*,delete) + # delete tag + if [ "$allowdeletetag" != "true" ]; then + echo "*** Deleting a tag is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/tags/*,tag) + # annotated tag + if [ "$allowmodifytag" != "true" ] && git rev-parse $refname > /dev/null 2>&1 + then + echo "*** Tag '$refname' already exists." >&2 + echo "*** Modifying a tag is not allowed in this repository." >&2 + exit 1 + fi + ;; + refs/heads/*,commit) + # branch + if [ "$oldrev" = "$zero" -a "$denycreatebranch" = "true" ]; then + echo "*** Creating a branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/heads/*,delete) + # delete branch + if [ "$allowdeletebranch" != "true" ]; then + echo "*** Deleting a branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/remotes/*,commit) + # tracking branch + ;; + refs/remotes/*,delete) + # delete tracking branch + if [ "$allowdeletebranch" != "true" ]; then + echo "*** Deleting a tracking branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + *) + # Anything else (is there anything else?) + echo "*** Update hook: unknown type of update to ref $refname of type $newrev_type" >&2 + exit 1 + ;; +esac + +# --- Finished +exit 0 diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/index b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/index new file mode 100644 index 0000000000000000000000000000000000000000..cc47fea64fe76f4629a51a4e31a41d4b62088dfc GIT binary patch literal 324 zcmZ?q402{*U|<5_H0v`SR)y9-(~NxP%BbaCVPs$s5{Z{cV_;}p!oa}z4X8#0h)a4m zB^}*0d)nniS#jFJ_QHZwp8OPL;L=OaEXhpI%P&d=ssV#En`?7rUhaDZqao&rm;lXt zi)5ZheoCIV>9 zSwAtkBr`uxuQ&r@Pe_ofE0C4KV5DHk6)k*FH)q$nsaKD)n1)VLI{DP_=2GlNF&F}s zUq7qWUgwn=aBa!7J(n--i`sT7T?J?bP|kqMRBj2Y@YY$Sx(-+QuRi@_V3pfvRjXj! WS8==g+ru+mb24YRX-;A1&j0{oNpju* literal 0 HcmV?d00001 diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/info/exclude b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/info/exclude new file mode 100644 index 00000000..a5196d1b --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/info/exclude @@ -0,0 +1,6 @@ +# git ls-files --others --exclude-from=.git/info/exclude +# Lines that start with '#' are comments. +# For a project mostly in C, the following would be a good set of +# exclude patterns (uncomment them if you want to use them): +# *.[oa] +# *~ diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/logs/HEAD b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/logs/HEAD new file mode 100644 index 00000000..8c80fe6d --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/logs/HEAD @@ -0,0 +1,4 @@ +0000000000000000000000000000000000000000 0d0095113b5be7f4fcdfc972268318ec902c5f13 Ryan Baxter <524254+ryanjbaxter@users.noreply.github.com> 1715194973 -0400 commit (initial): initial commit +0d0095113b5be7f4fcdfc972268318ec902c5f13 c7c3fa38fd33170e7fbb15541066ebe746ba1ad6 Ryan Baxter <524254+ryanjbaxter@users.noreply.github.com> 1715202289 -0400 commit: moving action.sh +c7c3fa38fd33170e7fbb15541066ebe746ba1ad6 18c66e805702c81fc2099cb09d2490f099581f34 Ryan Baxter <524254+ryanjbaxter@users.noreply.github.com> 1715260171 -0400 commit: changing permissions +18c66e805702c81fc2099cb09d2490f099581f34 193a7a691db1f7529bbd1d7f7f4947209622486c Ryan Baxter <524254+ryanjbaxter@users.noreply.github.com> 1715263189 -0400 commit: updating action diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/logs/refs/heads/main b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/logs/refs/heads/main new file mode 100644 index 00000000..8c80fe6d --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/logs/refs/heads/main @@ -0,0 +1,4 @@ +0000000000000000000000000000000000000000 0d0095113b5be7f4fcdfc972268318ec902c5f13 Ryan Baxter <524254+ryanjbaxter@users.noreply.github.com> 1715194973 -0400 commit (initial): initial commit +0d0095113b5be7f4fcdfc972268318ec902c5f13 c7c3fa38fd33170e7fbb15541066ebe746ba1ad6 Ryan Baxter <524254+ryanjbaxter@users.noreply.github.com> 1715202289 -0400 commit: moving action.sh +c7c3fa38fd33170e7fbb15541066ebe746ba1ad6 18c66e805702c81fc2099cb09d2490f099581f34 Ryan Baxter <524254+ryanjbaxter@users.noreply.github.com> 1715260171 -0400 commit: changing permissions +18c66e805702c81fc2099cb09d2490f099581f34 193a7a691db1f7529bbd1d7f7f4947209622486c Ryan Baxter <524254+ryanjbaxter@users.noreply.github.com> 1715263189 -0400 commit: updating action diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/0d/0095113b5be7f4fcdfc972268318ec902c5f13 b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/0d/0095113b5be7f4fcdfc972268318ec902c5f13 new file mode 100644 index 00000000..e9aefade --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/0d/0095113b5be7f4fcdfc972268318ec902c5f13 @@ -0,0 +1,2 @@ +xK +0aYŝ%I ".$Fڦ)u N?8?K H9t!%;;ܶ=3!e~pֲ1W{])2#a M +@W'(s,я7K] \ No newline at end of file diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/0d/65649266e723e7033103f9b6ae757ec6580057 b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/0d/65649266e723e7033103f9b6ae757ec6580057 new file mode 100644 index 00000000..8a1aad43 --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/0d/65649266e723e7033103f9b6ae757ec6580057 @@ -0,0 +1,2 @@ +x=M ]s +F{GcGFJCi#]||38D76S0VZqNFhF!jI.m a$Wgy>ݾs8&cmiesL~y69Vuz$'.8'$6 \ No newline at end of file diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/0f/5f2470dfcc0e605318d3559a527b90d3200f4d b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/0f/5f2470dfcc0e605318d3559a527b90d3200f4d new file mode 100644 index 0000000000000000000000000000000000000000..759614722194f39092d82c8a7eed4f178180d987 GIT binary patch literal 46 zcmb9XD~D{FgG<-NK7ut%+J#+&S04M!sF&L`HQnE7`RWaaq<9XD~D{FgG<-NK7ut%+J#+&S1z-$@4b-wyODUZozgh-hl5J MGF#6A08Y{o9Yq%x5C8xG literal 0 HcmV?d00001 diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/5b/13c12d6cbaae95d5c70435559222c9e531d9a5 b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/5b/13c12d6cbaae95d5c70435559222c9e531d9a5 new file mode 100644 index 0000000000000000000000000000000000000000..6ca3717696202d440cf769526bd1d242127c1431 GIT binary patch literal 104 zcmV-u0GI!G0V^p=O;xZkXD~D{Ff%bx&`ZxO$xP47FG^+T-IR26*X(JR7iGn13)>3| zPI>ZE)WiS?6pD%~^OAKF^GfoI5_OAG(^894^O92;uAkLvuk*?bxVB{4p39f^MQuBk Kt^xph+$MEXaxkp` literal 0 HcmV?d00001 diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/64/cdce59318eb9c6b81014c4fe0339ab48bbbbc2 b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/64/cdce59318eb9c6b81014c4fe0339ab48bbbbc2 new file mode 100644 index 0000000000000000000000000000000000000000..3725022898df8fc16413cc5cfd16bed59b3fa7e8 GIT binary patch literal 103 zcmV-t0GR)H0V^p=O;xZkXD~D{Ff%bx&`ZxO$xP47FG^+T-IR26*X(JR7iGn13)>3| zPI>ZE)WiS?6pD%~^OAKF^GfoI5_OAG(^894^O92;_~TUy?w{dH2$r}UIxDDp!es@1 JUjS8MBLDl2EwBIp literal 0 HcmV?d00001 diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/6f/646e4b35f6aa83ed6d70b74a0d50f7681cb5cd b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/6f/646e4b35f6aa83ed6d70b74a0d50f7681cb5cd new file mode 100644 index 0000000000000000000000000000000000000000..674584ce718813e1501dcfbc89bd4d06b323ade2 GIT binary patch literal 73 zcmV-P0Ji^l0ZYosPf{>9Vo+ApPs+^GPf9G#;NnV6&d66#3a-pcPEAor$xkj;f(WT2 f38^dCDd?Bv7U-u|q$Zb^q^87!6mkIodQ4#FT5gk5tA_D1q3f0`I$Jc2g>`igC&G?X@Sdx;BolP{BRrr1Ea zk%#0a^o4rk#bCvG=!M`0&yrS#EnxN?nlp6ysP(X^tHjFy6Qg0W*D8 zJJW~#l$Nimlbw>s+}PxP?7pp-S2m}N%e%5Lme=N3)7{z`t~w0>7kUB-KuD}~Z|yP7 K|CKNL={Jv#Wlb>v literal 0 HcmV?d00001 diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/88/9850e6e4256269c906a85b252073b9b71deb1d b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/88/9850e6e4256269c906a85b252073b9b71deb1d new file mode 100644 index 0000000000000000000000000000000000000000..2cbe1476f027915a38c67e9c37aa349e13f1164e GIT binary patch literal 88 zcmV-e0H^AWiT`_Ff%bx&`ZxO$xP47FG^+T-IR26*X(JR7iGn13)>3| uPI>ZE6sjsQxg;|`Pp>$GVd4vqo6F=c&Z=PGKDoxpS7@qweg**6gdYPoLnZJ4 literal 0 HcmV?d00001 diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/8d/b262c5ba9b96d3a26a5e2b133f131194e4f915 b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/8d/b262c5ba9b96d3a26a5e2b133f131194e4f915 new file mode 100644 index 0000000000000000000000000000000000000000..107086caa8602a68435c07be3b99ca1bfe6ebf83 GIT binary patch literal 115 zcmV-(0F3{50UeAn4#F@DMVWmHq;4J@b?E`P2y%ldK_RhhBh;m5C$PN#q%Xa-_Vql^ z%Lxyd5O4w-L%FiMay)?4`crZMxkQw>}J8f^CyXaP<;0zH$==r1GjissY_O VN4Nc-L-LP8%Dwr!egQQICwL=lGtdA4 literal 0 HcmV?d00001 diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/91/e848d9a61fd19a78000bc9ac424d1295276f68 b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/91/e848d9a61fd19a78000bc9ac424d1295276f68 new file mode 100644 index 0000000000000000000000000000000000000000..9c0c2bde60b868af294dfbaae92cd804ed956056 GIT binary patch literal 48 zcmV-00MGw;0ZYosPf{>8Vo+ApPs+^GPf9G#;NnV6&d66#3a-pcPEAor$xkj;;sOBf G)C=w%hZb4@ literal 0 HcmV?d00001 diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/a3/ffcc384822decb6bc5599bb29a74bbf22dc45e b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/a3/ffcc384822decb6bc5599bb29a74bbf22dc45e new file mode 100644 index 00000000..103db39a --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/a3/ffcc384822decb6bc5599bb29a74bbf22dc45e @@ -0,0 +1,2 @@ +x=A D]s +FAc<7(Hk- m~]y =Lt4]T} J{GͰΉ<2 iOj;kF'2z_=Ï]%ELUE?c tFeA:+(=H"6[ \ No newline at end of file diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/ae/f837338280bc8fe836d413402a84ec43a712fe b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/ae/f837338280bc8fe836d413402a84ec43a712fe new file mode 100644 index 0000000000000000000000000000000000000000..1835319bf8bd859f1354a5c9954093b72783f8ef GIT binary patch literal 103 zcmV-t0GR)H0V^p=O;xZkXD~D{Ff%bx&`ZxO$xP47FG^+T-IR26*X(JR7iGn13)>3| zPI>ZE)WiS?6pD%~^OAKF^GfoI5_OAG(^894^O92;wwr~qGFl3#DJB>Ps`1RYZZA{R J0RT7@Aim+0EF}N{ literal 0 HcmV?d00001 diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/b7/3656050139102621603351260c98d73f1c7288 b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/b7/3656050139102621603351260c98d73f1c7288 new file mode 100644 index 0000000000000000000000000000000000000000..380f2bc7e19fe8ad45f0db1151ce540fc195c8d7 GIT binary patch literal 45 zcmV+|0Mh?>0V^p=O;s>9U@$QN0)^tDWCp{DUK4aYA5EIz{^YvYtER%390z*<>_iRW DZq^cn literal 0 HcmV?d00001 diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/bb/4e47ec1aa0b5a2dec0ede431ed10577f98c7ef b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/bb/4e47ec1aa0b5a2dec0ede431ed10577f98c7ef new file mode 100644 index 0000000000000000000000000000000000000000..47f16e0c8509e51c7029cc6de6c85d3e4fad999f GIT binary patch literal 54 zcmV-60LlM&0V^p=O;s>9XD~D{Ff%bxNK7ut%+J#+&S04M!sF&L`HQnE7`RWaaq<i2SaNX`2YX_ literal 0 HcmV?d00001 diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/c1/eb48842df92c8f185796de35a43f789363eeab b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/c1/eb48842df92c8f185796de35a43f789363eeab new file mode 100644 index 0000000000000000000000000000000000000000..ea5fefecc7db3f9cec8675d65307a663ec094fa5 GIT binary patch literal 157 zcmV;O0Al}m0X>dE4#FT5L|tVX8 zY}6r`(b>eI1JHz688WW%%G=Ic-AGxVD?B@^L0a-yv6L6bZJ4GZu~Zy82oP9*bMGR5 zXsJJbjvG?en`*Fh@!ieGf1cjNb(aX0LG@w_tGB1 L{9pM1t8h09q&!Q) literal 0 HcmV?d00001 diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/c7/c3fa38fd33170e7fbb15541066ebe746ba1ad6 b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/c7/c3fa38fd33170e7fbb15541066ebe746ba1ad6 new file mode 100644 index 00000000..bfb37c55 --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/c7/c3fa38fd33170e7fbb15541066ebe746ba1ad6 @@ -0,0 +1 @@ +xQN q9żacG05[Pj ~>۶v)<&ce 1Y1[lR:&$Sa"#]Fţ/=?]:s;+KۇRܮH !Qz^1 Dk-þ_Z \ No newline at end of file diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/d7/cd2a877e4a6950d6a496bcd3d2be5ab6ca6724 b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/objects/d7/cd2a877e4a6950d6a496bcd3d2be5ab6ca6724 new file mode 100644 index 0000000000000000000000000000000000000000..7c084fbbd7adc19cb20c8bd9ef260b531f6c3461 GIT binary patch literal 45 zcmbY78*=~G`>#XQ~r>q~!QXx@BLhTD0(oB()@ B5<~z1 literal 0 HcmV?d00001 diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/refs/heads/main b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/refs/heads/main new file mode 100644 index 00000000..df82ef82 --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/refs/heads/main @@ -0,0 +1 @@ +193a7a691db1f7529bbd1d7f7f4947209622486c diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/refs/tags/v0.0.16 b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/refs/tags/v0.0.16 new file mode 100644 index 00000000..07f2e5a1 --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/git/refs/tags/v0.0.16 @@ -0,0 +1 @@ +0d65649266e723e7033103f9b6ae757ec6580057 diff --git a/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/rsync-antora-reference/src/action.sh b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/rsync-antora-reference/src/action.sh new file mode 100755 index 00000000..6f646e4b --- /dev/null +++ b/projects/spring-cloud/src/test/resources/projects/spring-docs-actions/rsync-antora-reference/src/action.sh @@ -0,0 +1,4 @@ +#!/bin/bash + +echo "Synced docs" +echo 'Synced docs' > /tmp/executed_docs diff --git a/releaser-core/src/main/java/releaser/internal/Releaser.java b/releaser-core/src/main/java/releaser/internal/Releaser.java index fe8ba8a7..336adc9d 100644 --- a/releaser-core/src/main/java/releaser/internal/Releaser.java +++ b/releaser-core/src/main/java/releaser/internal/Releaser.java @@ -90,6 +90,15 @@ public class Releaser { return this.projectGitHandler.cloneProjectFromOrg(projectName); } + public ExecutionResult buildAntoraDocs(File project) { + String currentBranch = projectGitHandler.currentBranch(project); + projectGitHandler.cloneAndCheckoutDocsBuild(project); + this.projectCommandExecutor.runAntora(this.releaserProperties, originalVersion(project), + new ProjectVersion(project), project.getAbsolutePath()); + projectGitHandler.checkout(project, currentBranch); + return ExecutionResult.success(); + } + public Projects retrieveVersionsFromBom() { return this.projectPomUpdater.retrieveVersionsFromReleaseTrainBom(); } @@ -122,6 +131,12 @@ public class Releaser { return ExecutionResult.success(); } + public ExecutionResult runAntoraBuild(ReleaserProperties properties, ProjectVersion originalVersion, + ProjectVersion versionFromBom) { + this.projectCommandExecutor.runAntora(properties, originalVersion, versionFromBom, properties.getWorkingDir()); + return ExecutionResult.success(); + } + public ExecutionResult commitAndPushTags(File project, ProjectVersion changedVersion) { this.projectGitHandler.commitAndTagIfApplicable(project, changedVersion); log.info("\nCommit was made and tag was pushed successfully"); @@ -135,9 +150,9 @@ public class Releaser { return ExecutionResult.success(); } - public ExecutionResult publishDocs(ReleaserProperties properties, ProjectVersion originalVersion, - ProjectVersion changedVersion) { - this.projectCommandExecutor.publishDocs(properties, originalVersion, changedVersion); + public ExecutionResult publishDocs(ReleaserProperties properties, File project) { + File springDocsActionsProject = this.projectGitHandler.cloneAndCheckoutSpringDocsActions(); + this.projectCommandExecutor.publishAntoraDocs(springDocsActionsProject, project, properties); log.info("\nThe docs were published successfully"); return ExecutionResult.success(); } diff --git a/releaser-core/src/main/java/releaser/internal/ReleaserProperties.java b/releaser-core/src/main/java/releaser/internal/ReleaserProperties.java index 5176229f..e129ad27 100644 --- a/releaser-core/src/main/java/releaser/internal/ReleaserProperties.java +++ b/releaser-core/src/main/java/releaser/internal/ReleaserProperties.java @@ -78,6 +78,8 @@ public class ReleaserProperties implements Serializable { private Versions versions = new Versions(); + private Antora antora = new Antora(); + private boolean commercial = false; /** @@ -208,12 +210,21 @@ public class ReleaserProperties implements Serializable { this.commercial = commercial; } + public Antora getAntora() { + return antora; + } + + public void setAntora(Antora antora) { + this.antora = antora; + } + @Override public String toString() { return "ReleaserProperties{" + "workingDir='" + this.workingDir + '\'' + ", git=" + this.git + ", pom=" + this.pom + ", maven=" + this.maven + ", gradle=" + this.gradle + ", sagan=" + this.sagan + ", fixedVersions=" + this.fixedVersions + ", metaRelease=" + this.metaRelease + ", template=" - + this.template + ", versions=" + this.versions + ", commercial=" + this.commercial + '}'; + + this.template + ", versions=" + this.versions + ", commercial=" + this.commercial + ", antora=" + + this.antora + '}'; } public ReleaserProperties copy() { @@ -436,6 +447,58 @@ public class ReleaserProperties implements Serializable { } + public static class Antora implements Serializable { + + /** + * URL to Spring Docs Actions repo. + */ + private String springDocsActionsUrl; + + /** + * Command to sync Antora docs. + */ + private String syncAntoraDocsCommand; + + /** + * Tag for Spring Docs Actions repo. + */ + private String springDocsActionsTag; + + public String getSpringDocsActionsUrl() { + return springDocsActionsUrl; + } + + public void setSpringDocsActionsUrl(String springDocsActionsUrl) { + this.springDocsActionsUrl = springDocsActionsUrl; + } + + public String getSpringDocsActionsTag() { + return springDocsActionsTag; + } + + public void setSpringDocsActionsTag(String springDocsActionsTag) { + this.springDocsActionsTag = springDocsActionsTag; + } + + public String getSyncAntoraDocsCommand() { + return syncAntoraDocsCommand; + } + + public void setSyncAntoraDocsCommand(String syncAntoraDocsCommand) { + this.syncAntoraDocsCommand = syncAntoraDocsCommand; + } + + @Override + public String toString() { + return new StringJoiner(", ", Antora.class.getSimpleName() + "[", "]") + .add("springDocsActionsUrl='" + springDocsActionsUrl + "'") + .add("syncAntoraDocsCommand='" + syncAntoraDocsCommand + "'") + .add("springDocsActionsTag='" + springDocsActionsTag + "'").toString(); + + } + + } + public static class Git implements Serializable { /** @@ -1021,6 +1084,8 @@ public class ReleaserProperties implements Serializable { private String generateReleaseTrainDocsCommand = "bash release_train.sh " + "--retrieveversions --version {{version}} --ghpages --auto"; + private String runAntoraCommand = "./mvnw antora {{systemProps}}"; + /** * Additional system properties that should be passed to the build / deploy * commands. If present in other commands "{{systemProps}}" will be substituted @@ -1101,12 +1166,20 @@ public class ReleaserProperties implements Serializable { this.systemProperties = systemProperties; } + public String getRunAntoraCommand() { + return runAntoraCommand; + } + + public void setRunAntoraCommand(String runAntoraCommand) { + this.runAntoraCommand = runAntoraCommand; + } + @Override public String toString() { return "Maven{" + "buildCommand='" + this.buildCommand + '\'' + ", deployCommand='" + this.deployCommand + '\'' + ", publishDocsCommand=" + this.publishDocsCommand + "generateReleaseTrainDocsCommand='" - + this.generateReleaseTrainDocsCommand + '\'' + ", waitTimeInMinutes=" + this.waitTimeInMinutes - + '}'; + + this.generateReleaseTrainDocsCommand + '\'' + ", runAntoraCommand= " + + runAntoraCommand + ", waitTimeInMinutes=" + this.waitTimeInMinutes + '}'; } } diff --git a/releaser-core/src/main/java/releaser/internal/git/GitRepo.java b/releaser-core/src/main/java/releaser/internal/git/GitRepo.java index 49096bf2..44c52580 100644 --- a/releaser-core/src/main/java/releaser/internal/git/GitRepo.java +++ b/releaser-core/src/main/java/releaser/internal/git/GitRepo.java @@ -184,6 +184,21 @@ class GitRepo { } } + void checkoutTag(String tagName) { + try (Git git = this.gitFactory.open(file(this.basedir))) { + Optional tagId = findTagIdByName(tagName, true); + if (tagId.isPresent()) { + git.checkout().setName(tagId.get().getName()).call(); + } + else { + throw new IllegalStateException("Tag with name [" + tagName + "] not found"); + } + } + catch (Exception e) { + throw new IllegalStateException(e); + } + } + /** * Attempt to retrieve a tag id from a name, prepending the name with /refs/tags/. */ diff --git a/releaser-core/src/main/java/releaser/internal/git/ProjectGitHandler.java b/releaser-core/src/main/java/releaser/internal/git/ProjectGitHandler.java index fcdf3eb8..431893cb 100644 --- a/releaser-core/src/main/java/releaser/internal/git/ProjectGitHandler.java +++ b/releaser-core/src/main/java/releaser/internal/git/ProjectGitHandler.java @@ -130,6 +130,16 @@ public class ProjectGitHandler implements Closeable { this.properties.getGit().getSpringProjectBranch()); } + public void cloneAndCheckoutDocsBuild(File project) { + checkout(project, "docs-build"); + } + + public File cloneAndCheckoutSpringDocsActions() { + File project = cloneProject(this.properties.getAntora().getSpringDocsActionsUrl()); + checkoutTag(project, this.properties.getAntora().getSpringDocsActionsTag()); + return project; + } + private File cloneAndCheckOut(String springProjectUrl, String springProjectUrlBranch) { File clonedProject = cloneProject(springProjectUrl); checkout(clonedProject, springProjectUrlBranch); @@ -146,12 +156,7 @@ public class ProjectGitHandler implements Closeable { * @return location of the cloned project */ public File cloneProjectFromOrg(String projectName) { - String orgUrl = this.properties.getMetaRelease().getGitOrgUrl(); - String fullUrl = orgUrl.endsWith("/") ? (orgUrl + projectName) - : (orgUrl + "/" + addCommercialSuffix(projectName) + suffixNonHttpRepo(orgUrl)); - if (log.isDebugEnabled()) { - log.debug("Full url of the project is [{}]", fullUrl); - } + String fullUrl = createRepoUrlFromProject(projectName); File clonedProject = cloneProject(fullUrl); if (log.isDebugEnabled()) { log.debug("Successfully cloned the project to [{}]", clonedProject); @@ -192,6 +197,16 @@ public class ProjectGitHandler implements Closeable { return findAndCheckOutBranchForVersion(clonedProject, versions); } + private String createRepoUrlFromProject(String projectName) { + String orgUrl = this.properties.getMetaRelease().getGitOrgUrl(); + String fullUrl = orgUrl.endsWith("/") ? (orgUrl + projectName) + : (orgUrl + "/" + addCommercialSuffix(projectName) + suffixNonHttpRepo(orgUrl)); + if (log.isDebugEnabled()) { + log.debug("Full url of the project is [{}]", fullUrl); + } + return fullUrl; + } + private File findAndCheckOutBranchForVersion(File clonedProject, String[] versions) { if (log.isDebugEnabled()) { log.debug("Checking versions {} for project [{}]", versions, clonedProject); @@ -271,6 +286,11 @@ public class ProjectGitHandler implements Closeable { return new File(destinationFolder, projectUrl.getHumanishName()); } + public void checkoutTag(File project, String tag) { + log.info("checkout tag: " + tag); + gitRepo(project).checkoutTag(tag); + } + public void checkout(File project, String branch) { log.info("checkout project: " + project + " with branch: " + branch); gitRepo(project).checkout(branch); diff --git a/releaser-core/src/main/java/releaser/internal/project/ProjectCommandExecutor.java b/releaser-core/src/main/java/releaser/internal/project/ProjectCommandExecutor.java index 050600d5..456f7be6 100644 --- a/releaser-core/src/main/java/releaser/internal/project/ProjectCommandExecutor.java +++ b/releaser-core/src/main/java/releaser/internal/project/ProjectCommandExecutor.java @@ -96,6 +96,19 @@ public class ProjectCommandExecutor { } } + public void runAntora(ReleaserProperties properties, ProjectVersion originalVersion, + ProjectVersion versionFromReleaseTrain, String projectRoot) { + try { + String command = new CommandPicker(properties, projectRoot).runAntoraCommand(versionFromReleaseTrain); + String[] commands = replaceAllPlaceHolders(originalVersion, versionFromReleaseTrain, command).split(" "); + runCommand(properties, projectRoot, commands); + } + catch (Exception e) { + String message = properties + "\n" + originalVersion + "\n" + versionFromReleaseTrain + "\n" + projectRoot; + throw new IllegalStateException(message, e); + } + } + public void generateReleaseTrainDocs(ReleaserProperties properties, String version, String projectRoot) { try { String updatedCommand = new CommandPicker(properties, projectRoot) @@ -166,6 +179,12 @@ public class ProjectCommandExecutor { return new ReleaserProcessExecutor(workDir); } + public void publishAntoraDocs(File antoraDocsProject, File project, ReleaserProperties properties) { + String command = new CommandPicker(properties).publishAntoraDocsCommand(project, properties); + log.info("Executing command for publishing Antora docs " + command + " / " + properties); + runCommand(properties, antoraDocsProject.getAbsolutePath(), command.split(" ")); + } + public void publishDocs(ReleaserProperties properties, ProjectVersion originalVersion, ProjectVersion changedVersion) { try { @@ -307,6 +326,21 @@ class CommandPicker { return bashCommandWithSystemProps(releaserProperties.getBash().getBuildCommand()); } + String runAntoraCommand(ProjectVersion version) { + // TODO handle gradle and bash? + return mavenCommandWithSystemProps(releaserProperties.getMaven().getRunAntoraCommand(), version); + } + + String publishAntoraDocsCommand(File project, ReleaserProperties properties) { + ProjectVersion version = new ProjectVersion(project); + String repo = properties.getGit().getOrgName() + "/" + version.projectName; + // TODO this needs to be a property + return bashCommandWithSystemProps("./rsync-antora-reference/src/action.sh" + + " --docs-username \"$DOCS_SERVER_SSH_USER\" --docs-host \"docs.spring.io\" --docs-ssh-key \"$(cat $DOCS_SERVER_SSH_KEY)\" --docs-ssh-host-key \"#\" --site-path \"" + + project.getAbsolutePath() + "/target/antora/site\" --github-repository \"" + repo + + "\" --dry-run {{systemProps}}"); + } + String version() { // makes more sense to use PomReader if (projectType == ProjectType.GRADLE) { diff --git a/releaser-spring/src/main/java/releaser/internal/tasks/release/PublishDocsReleaseTask.java b/releaser-spring/src/main/java/releaser/internal/tasks/release/PublishDocsReleaseTask.java index 76e8b872..17d7a9c8 100644 --- a/releaser-spring/src/main/java/releaser/internal/tasks/release/PublishDocsReleaseTask.java +++ b/releaser-spring/src/main/java/releaser/internal/tasks/release/PublishDocsReleaseTask.java @@ -56,7 +56,10 @@ public class PublishDocsReleaseTask implements ReleaseReleaserTask { @Override public ExecutionResult runTask(Arguments args) { - return this.releaser.publishDocs(args.properties, args.originalVersion, args.versionFromBom); + if (this.releaser.buildAntoraDocs(args.project).isSuccess()) { + return this.releaser.publishDocs(args.properties, args.project); + } + return ExecutionResult.failure(new RuntimeException("Failed to build Antora docs")); } @Override diff --git a/releaser-test/src/main/java/releaser/internal/buildsystem/TestUtils.java b/releaser-test/src/main/java/releaser/internal/buildsystem/TestUtils.java index e1a66c5f..ca2b3007 100644 --- a/releaser-test/src/main/java/releaser/internal/buildsystem/TestUtils.java +++ b/releaser-test/src/main/java/releaser/internal/buildsystem/TestUtils.java @@ -35,6 +35,7 @@ public final class TestUtils { prepareLocalRepo("target/test-classes/projects/", "spring-cloud-consul"); prepareLocalRepo("target/test-classes/projects/", "spring-cloud-build"); prepareLocalRepo("target/test-classes/projects/", "spring-cloud-static-angel"); + prepareLocalRepo("target/test-classes/projects/", "spring-docs-actions"); } private static void prepareLocalRepo(String buildDir, String repoPath) throws IOException { diff --git a/releaser-test/src/main/java/releaser/internal/spring/ArgsBuilder.java b/releaser-test/src/main/java/releaser/internal/spring/ArgsBuilder.java index 2ed756dd..78c46f7d 100644 --- a/releaser-test/src/main/java/releaser/internal/spring/ArgsBuilder.java +++ b/releaser-test/src/main/java/releaser/internal/spring/ArgsBuilder.java @@ -39,6 +39,8 @@ public class ArgsBuilder { private final File tempDirAllTestSample; + private File tempDirSpringDocsActions; + List args = new LinkedList<>(); public ArgsBuilder(File project, File tempDirTestSamplesProject, File tempDirReleaseTrainDocs, @@ -58,11 +60,13 @@ public class ArgsBuilder { "releaser.git.documentation-url=" + file("/projects/spring-cloud-static-angel/").toURI(), "releaser.git.test-samples-project-url=" + tempDirTestSamplesProject.getAbsolutePath(), "releaser.git.release-train-docs-url=" + tempDirReleaseTrainDocs.getAbsolutePath(), + "releaser.antora.spring-docs-actions-url=" + file("/projects/spring-docs-actions").toURI(), "releaser.maven.build-command=echo build", "releaser.maven.deploy-command=echo deploy", "releaser.maven.deploy-guides-command=echo guides", "releaser.maven.publish-docs-command=echo docs", "releaser.maven.generate-release-train-docs-command=echo releaseTrainDocs", + "releaser.maven.run-antora-command=echo antora", "releaser.working-dir=" + project.getPath(), "releaser.git.spring-project-url=" + tempDirSpringCloud.getAbsolutePath(), "releaser.git.release-train-wiki-url=" + tmpGitRepo(tempDirReleaseTrainWiki).getAbsolutePath() + "/",