SpringCloud/spring-cloud-release-tools
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updates the Release Train table in Spring project

Browse Source 
fixes gh-93
This commit is contained in:
Marcin Grzejszczak
2018-10-18 15:27:12 +02:00
parent a9945f2df3
commit 9d8235e310
82 changed files with 3271 additions and 152 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
spring-cloud-release-tools-spring/src/main/java/org/springframework/cloud/release/internal/spring/ReleaserConfiguration.java
View File

@@ -76,8 +76,9 @@ class ReleaserConfiguration {
}
@Bean
DocumentationUpdater documentationUpdater(ReleaserProperties properties, ProjectGitHandler handler) {
return new DocumentationUpdater(properties, handler);
DocumentationUpdater documentationUpdater(ProjectGitHandler projectGitHandler,
ReleaserProperties properties) {
return new DocumentationUpdater(projectGitHandler, properties);
}
@Bean

9
spring-cloud-release-tools-spring/src/main/java/org/springframework/cloud/release/internal/spring/Tasks.java
View File

@@ -71,6 +71,12 @@ class Tasks {
args -> {
args.releaser.updateDocumentationRepository(args.properties, args.versionFromScRelease);
},TaskType.POST_RELEASE);
static Task UPDATE_SPRING_PROJECT_PAGE = task("updateSpringProjectPage", "up",
"UPDATE SPRING PROJECT PAGE",
"Updating Spring Project page",
args -> {
args.releaser.updateSpringProjectPage(args.projects);
},TaskType.POST_RELEASE);
static final List<Task> DEFAULT_TASKS_PER_PROJECT = Stream.of(
Tasks.UPDATING_POMS,
@@ -87,7 +93,8 @@ class Tasks {
static final List<Task> DEFAULT_TASKS_PER_RELEASE = Stream.of(
Tasks.CREATE_TEMPLATES,
Tasks.UPDATE_GUIDES,
Tasks.UPDATE_DOCUMENTATION
Tasks.UPDATE_DOCUMENTATION,
Tasks.UPDATE_SPRING_PROJECT_PAGE
).collect(Collectors.toList());
static final List<Task> NON_COMPOSITE_TASKS = new ArrayList<Task>() {

66
spring-cloud-release-tools-spring/src/test/java/org/springframework/cloud/release/internal/docs/TestDocumentationUpdater.java
View File

@@ -5,38 +5,60 @@ import java.io.IOException;
import org.springframework.cloud.release.internal.ReleaserProperties;
import org.springframework.cloud.release.internal.git.ProjectGitHandler;
import org.springframework.cloud.release.internal.pom.Projects;
/**
* @author Marcin Grzejszczak
*/
public class TestDocumentationUpdater extends DocumentationUpdater {
private final String version;
public TestDocumentationUpdater(ReleaserProperties properties,
ProjectGitHandler gitHandler, String version) {
super(properties, gitHandler);
this.version = version;
TestProjectDocumentationUpdater updater, TestReleaseContentsUpdater testRelease) {
super(properties, updater, testRelease);
}
@Override
String readIndexHtmlContents(File indexHtml) throws IOException {
return response();
public static class TestReleaseContentsUpdater extends ReleaseTrainContentsUpdater {
public TestReleaseContentsUpdater(ReleaserProperties properties, ProjectGitHandler handler) {
super(properties, handler);
}
@Override
public File updateProjectRepo(Projects projects) {
return super.updateProjectRepo(projects);
}
}
private String response() {
return "<!DOCTYPE HTML>\n"
+ "\n"
+ "<meta charset=\"UTF-8\">\n"
+ "<meta http-equiv=\"refresh\" content=\"1; url=http://cloud.spring.io/spring-cloud-static/" + this.version + "/\">\n"
+ "\n"
+ "<script>\n"
+ " window.location.href = \"http://cloud.spring.io/spring-cloud-static/" + this.version + "/\"\n"
+ "</script>\n"
+ "\n"
+ "<title>Page Redirection</title>\n"
+ "\n"
+ "<!-- Note: don't tell people to `click` the link, just tell them that it is a link. -->\n"
+ "If you are not redirected automatically, follow the <a href='http://cloud.spring.io/spring-cloud-static/" + this.version + "/'>link to latest release</a>\n";
public static class TestProjectDocumentationUpdater extends ProjectDocumentationUpdater {
private final String version;
public TestProjectDocumentationUpdater(ReleaserProperties properties, ProjectGitHandler gitHandler, String version) {
super(properties, gitHandler);
this.version = version;
}
@Override
String readIndexHtmlContents(File indexHtml) throws IOException {
return response();
}
private String response() {
return "<!DOCTYPE HTML>\n"
+ "\n"
+ "<meta charset=\"UTF-8\">\n"
+ "<meta http-equiv=\"refresh\" content=\"1; url=http://cloud.spring.io/spring-cloud-static/" + this.version + "/\">\n"
+ "\n"
+ "<script>\n"
+ " window.location.href = \"http://cloud.spring.io/spring-cloud-static/" + this.version + "/\"\n"
+ "</script>\n"
+ "\n"
+ "<title>Page Redirection</title>\n"
+ "\n"
+ "<!-- Note: don't tell people to `click` the link, just tell them that it is a link. -->\n"
+ "If you are not redirected automatically, follow the <a href='http://cloud.spring.io/spring-cloud-static/" + this.version + "/'>link to latest release</a>\n";
}
}
}

1
spring-cloud-release-tools-spring/src/test/java/org/springframework/cloud/release/internal/pom/TestUtils.java
View File

@@ -8,6 +8,7 @@ import org.eclipse.jgit.util.FileUtils;
public class TestUtils {
public static void prepareLocalRepo() throws IOException {
prepareLocalRepo("target/test-classes/projects/", "spring-cloud");
prepareLocalRepo("target/test-classes/projects/", "spring-cloud-release");
prepareLocalRepo("target/test-classes/projects/", "spring-cloud-release-with-snapshot");
prepareLocalRepo("target/test-classes/projects/", "spring-cloud-consul");

63
spring-cloud-release-tools-spring/src/test/java/org/springframework/cloud/release/internal/spring/AcceptanceTests.java
View File

@@ -63,6 +63,7 @@ public class AcceptanceTests {
File springCloudConsulProject;
File temporaryFolder;
File documentationFolder;
File cloudProjectFolder;
TestProjectGitHandler gitHandler;
NonAssertingTestProjectGitHandler nonAssertingGitHandler;
SaganClient saganClient = Mockito.mock(SaganClient.class);
@@ -194,21 +195,23 @@ public class AcceptanceTests {
@Test
public void should_perform_a_meta_release_of_sc_release_and_consul() throws Exception {
// simulates an org
SpringReleaser releaser = metaReleaser(edgwareSr5());
SpringReleaser releaser = metaReleaser(edgwareSr10());
releaser.release(new OptionsBuilder().metaRelease(true).options());
// consul, release, documentation
then(this.nonAssertingGitHandler.clonedProjects).hasSize(3);
// consul, release, documentation, spring-cloud
then(this.nonAssertingGitHandler.clonedProjects).hasSize(4);
// don't want to verify the docs
thenAllStepsWereExecutedForEachProject();
thenSaganWasCalled();
thenDocumentationWasUpdated();
BDDAssertions.then(clonedProject("spring-cloud-consul").tagList().call())
.extracting("name").contains("refs/tags/v1.3.5.RELEASE");
BDDAssertions.then(gitProject(this.cloudProjectFolder).log().call().iterator().next().getShortMessage())
.contains("Updating project page to release train [Edgware.SR10]");
}
private Map<String, String> edgwareSr5() {
private Map<String, String> edgwareSr10() {
Map<String, String> versions = new LinkedHashMap<>();
versions.put("spring-boot", "1.5.16.RELEASE");
versions.put("spring-cloud-build", "1.3.11.RELEASE");
@@ -228,17 +231,22 @@ public class AcceptanceTests {
versions.put("spring-cloud-sleuth", "1.3.5.RELEASE");
versions.put("spring-cloud-contract", "1.2.6.RELEASE");
versions.put("spring-cloud-vault", "1.1.2.RELEASE");
versions.put("spring-cloud-release", "Edgware.SR5");
versions.put("spring-cloud-release", "Edgware.SR10");
return versions;
}
private Git clonedProject(String name) {
return GitTestUtils
.openGitProject(this.nonAssertingGitHandler.clonedProjects.stream()
.filter(file -> file.getName().contains(name))
.filter(file -> file.getName().equals(name))
.findFirst().get());
}
private Git gitProject(File file) {
return GitTestUtils
.openGitProject(file);
}
private void thenSaganWasCalled() {
BDDMockito.then(saganUpdater).should(BDDMockito.atLeastOnce())
.updateSagan(BDDMockito.anyString(),
@@ -248,7 +256,7 @@ public class AcceptanceTests {
private void thenAllStepsWereExecutedForEachProject() {
this.nonAssertingGitHandler.clonedProjects
.stream().filter(f -> !f.getName().contains("angel"))
.stream().filter(f -> !f.getName().contains("angel") && !f.getName().equals("spring-cloud"))
.forEach(project -> {
then(Arrays.asList("spring-cloud-starter-build",
"spring-cloud-consul")).contains(pom(project).getArtifactId());
@@ -269,7 +277,7 @@ public class AcceptanceTests {
releaser.release(new OptionsBuilder().metaRelease(true).options());
then(temporaryDestination.list()).isEmpty();
then(temporaryDestination.list()).containsOnly("spring-cloud");
}
@Test
@@ -285,8 +293,10 @@ public class AcceptanceTests {
.startFrom("spring-cloud-consul")
.options());
then(this.nonAssertingGitHandler.clonedProjects).hasSize(1);
// consul, cloud
then(this.nonAssertingGitHandler.clonedProjects).hasSize(2);
this.nonAssertingGitHandler.clonedProjects
.stream().filter(file -> file.getName().equals("spring-cloud-consul"))
.forEach(project -> {
then(pom(project).getArtifactId()).isEqualTo("spring-cloud-consul");
then(capture.toString()).contains("executed_build", "executed_deploy", "executed_docs");
@@ -308,8 +318,10 @@ public class AcceptanceTests {
.taskNames(Collections.singletonList("spring-cloud-consul"))
.options());
then(this.nonAssertingGitHandler.clonedProjects).hasSize(1);
// consul, cloud
then(this.nonAssertingGitHandler.clonedProjects).hasSize(2);
this.nonAssertingGitHandler.clonedProjects
.stream().filter(file -> !file.getName().equals("spring-cloud"))
.forEach(project -> {
then(Collections.singletonList("spring-cloud-consul"))
.contains(pom(project).getArtifactId());
@@ -593,7 +605,8 @@ public class AcceptanceTests {
GradleUpdater gradleUpdater = new GradleUpdater(properties);
SaganUpdater saganUpdater = new SaganUpdater(this.saganClient);
DocumentationUpdater documentationUpdater = new TestDocumentationUpdater(properties,
handler, "Brixton.SR1") {
new TestDocumentationUpdater.TestProjectDocumentationUpdater(properties, handler, "Brixton.SR1"),
new TestDocumentationUpdater.TestReleaseContentsUpdater(properties, handler)) {
@Override public File updateDocsRepo(ProjectVersion currentProject,
String springCloudReleaseBranch) {
File file = super.updateDocsRepo(currentProject, springCloudReleaseBranch);
@@ -614,7 +627,16 @@ public class AcceptanceTests {
TemplateGenerator templateGenerator = Mockito.spy(new TemplateGenerator(properties, handler));
GradleUpdater gradleUpdater = new GradleUpdater(properties);
SaganUpdater saganUpdater = Mockito.spy(new SaganUpdater(this.saganClient));
DocumentationUpdater documentationUpdater = Mockito.spy(new DocumentationUpdater(properties, handler) {
DocumentationUpdater documentationUpdater = Mockito.spy(new TestDocumentationUpdater(properties,
new TestDocumentationUpdater.TestProjectDocumentationUpdater(properties, handler, "Brixton.SR1"),
new TestDocumentationUpdater.TestReleaseContentsUpdater(properties, handler) {
@Override
public File updateProjectRepo(Projects projects) {
File file = super.updateProjectRepo(projects);
cloudProjectFolder = file;
return file;
}
}) {
@Override public File updateDocsRepo(ProjectVersion currentProject,
String springCloudReleaseBranch) {
File file = super.updateDocsRepo(currentProject, springCloudReleaseBranch);
@@ -633,13 +655,17 @@ public class AcceptanceTests {
private ReleaserProperties releaserProperties(File project, String branch) throws URISyntaxException {
ReleaserProperties releaserProperties = new ReleaserProperties();
releaserProperties.getGit().setReleaseTrainBomUrl(file("/projects/spring-cloud-release/").toURI().toString());
releaserProperties.getGit().setDocumentationUrl(file("/projects/spring-cloud-static-angel/").toURI().toString());
releaserProperties.getGit().setReleaseTrainBomUrl(
file("/projects/spring-cloud-release/").toURI().toString());
releaserProperties.getGit().setDocumentationUrl(
file("/projects/spring-cloud-static-angel/").toURI().toString());
releaserProperties.getMaven().setBuildCommand("echo build");
releaserProperties.getMaven().setDeployCommand("echo deploy");
releaserProperties.getMaven().setPublishDocsCommands(new String[] { "echo docs"} );
releaserProperties.setWorkingDir(project.getPath());
releaserProperties.getPom().setBranch(branch);
releaserProperties.getGit().setSpringProjectUrl(
tmpFile("spring-cloud").getAbsolutePath() + "/");
this.releaserProperties = releaserProperties;
return releaserProperties;
}
@@ -659,6 +685,8 @@ public class AcceptanceTests {
releaserProperties.getMaven().setPublishDocsCommands(new String[] { "echo executed_docs"} );
releaserProperties.getMetaRelease().setGitOrgUrl("file://" + this.temporaryFolder.getAbsolutePath());
releaserProperties.getMetaRelease().setEnabled(true);
releaserProperties.getGit().setSpringProjectUrl(
tmpFile("spring-cloud").getAbsolutePath() + "/");
releaserProperties.setFixedVersions(versions);
this.releaserProperties = releaserProperties;
return releaserProperties;
@@ -737,6 +765,13 @@ public class AcceptanceTests {
return file;
}
@Override
public File cloneSpringDocProject() {
File file = super.cloneSpringDocProject();
this.clonedProjects.add(file);
return file;
}
@Override public File cloneProjectFromOrg(String projectName) {
File file = super.cloneProjectFromOrg(projectName);
this.clonedProjects.add(file);

11
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/README.md Normal file
View File

@@ -0,0 +1,11 @@
This project is an umbrella and the git repository is used only for
documentation (see gh-pages branch). Home page: http://projects.spring.io/spring-cloud.
The sub-projects of Spring Cloud live in a different Github
organization: https://github.com/spring-cloud. Please use the
issue trackers in the individual projects there to report bugs and
request new features. Each project has a README with instructions
on how to build the source code and how to contribute ideas and code.
If you are looking for the project formerly known as Spring Cloud, please
go https://github.com/spring-cloud/spring-cloud-connectors.

1
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/HEAD Normal file
View File

@@ -0,0 +1 @@
ref: refs/heads/master

16
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/config Normal file
View File

@@ -0,0 +1,16 @@
[core]
repositoryformatversion = 0
filemode = true
bare = false
logallrefupdates = true
ignorecase = true
precomposeunicode = true
[remote "origin"]
url = git@github.com:spring-projects/spring-cloud.git
fetch = +refs/heads/*:refs/remotes/origin/*
[branch "master"]
remote = origin
merge = refs/heads/master
[branch "gh-pages"]
remote = origin
merge = refs/heads/gh-pages

1
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/description Normal file
View File

@@ -0,0 +1 @@
Unnamed repository; edit this file 'description' to name the repository.

15
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/hooks/applypatch-msg.sample Executable file
View File

@@ -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+"$@"}
:

24
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/hooks/commit-msg.sample Executable file
View File

@@ -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
}

8
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/hooks/post-update.sample Executable file
View File

@@ -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

14
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/hooks/pre-applypatch.sample Executable file
View File

@@ -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+"$@"}
:

49
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/hooks/pre-commit.sample Executable file
View File

@@ -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=4b825dc642cb6eb9a060e54bf8d69288fbee4904
fi
# If you want to allow non-ASCII filenames set this variable to true.
allownonascii=$(git config --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 --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 --

53
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/hooks/pre-push.sample Executable file
View File

@@ -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:
#
# <local ref> <local sha1> <remote ref> <remote sha1>
#
# This sample shows how to prevent push of commits where the log message starts
# with "WIP" (work in progress).
remote="$1"
url="$2"
z40=0000000000000000000000000000000000000000
while read local_ref local_sha remote_ref remote_sha
do
if [ "$local_sha" = $z40 ]
then
# Handle delete
:
else
if [ "$remote_sha" = $z40 ]
then
# New branch, examine all commits
range="$local_sha"
else
# Update to existing branch, examine new commits
range="$remote_sha..$local_sha"
fi
# Check for WIP commit
commit=`git rev-list -n 1 --grep '^WIP' "$range"`
if [ -n "$commit" ]
then
echo >&2 "Found WIP commit in $local_ref, not pushing"
exit 1
fi
fi
done
exit 0

169
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/hooks/pre-rebase.sample Executable file
View File

@@ -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

24
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/hooks/pre-receive.sample Executable file
View File

@@ -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

42
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/hooks/prepare-commit-msg.sample Executable file
View File

@@ -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

128
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/hooks/update.sample Executable file
View File

@@ -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 <ref> <oldrev> <newrev>)" >&2
exit 1
fi
if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then
echo "usage: $0 <ref> <oldrev> <newrev>" >&2
exit 1
fi
# --- Config
allowunannotated=$(git config --bool hooks.allowunannotated)
allowdeletebranch=$(git config --bool hooks.allowdeletebranch)
denycreatebranch=$(git config --bool hooks.denycreatebranch)
allowdeletetag=$(git config --bool hooks.allowdeletetag)
allowmodifytag=$(git config --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="0000000000000000000000000000000000000000"
if [ "$newrev" = "$zero" ]; then
newrev_type=delete
else
newrev_type=$(git cat-file -t $newrev)
fi
case "$refname","$newrev_type" in
refs/tags/*,commit)
# un-annotated tag
short_refname=${refname##refs/tags/}
if [ "$allowunannotated" != "true" ]; then
echo "*** The un-annotated tag, $short_refname, is not allowed in this repository" >&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

BIN
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/index Normal file
View File

Binary file not shown.

6
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/info/exclude Normal file
View File

@@ -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]
# *~

3
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/logs/HEAD Normal file
View File

@@ -0,0 +1,3 @@
0000000000000000000000000000000000000000 70c9a49fdcedbfad87ac23ea6862322578ac4c31 Marcin Grzejszczak <mgrzejszczak@pivotal.io> 1539862036 +0200 clone: from git@github.com:spring-projects/spring-cloud.git
70c9a49fdcedbfad87ac23ea6862322578ac4c31 66f767411e396c28b8ae4ca638824a741e9c2767 Marcin Grzejszczak <mgrzejszczak@pivotal.io> 1539863113 +0200 checkout: moving from master to gh-pages
66f767411e396c28b8ae4ca638824a741e9c2767 70c9a49fdcedbfad87ac23ea6862322578ac4c31 Marcin Grzejszczak <mgrzejszczak@pivotal.io> 1539863139 +0200 checkout: moving from gh-pages to master

1
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/logs/refs/heads/gh-pages Normal file
View File

@@ -0,0 +1 @@
0000000000000000000000000000000000000000 66f767411e396c28b8ae4ca638824a741e9c2767 Marcin Grzejszczak <mgrzejszczak@pivotal.io> 1539863113 +0200 branch: Created from refs/remotes/origin/gh-pages

1
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/logs/refs/heads/master Normal file
View File

@@ -0,0 +1 @@
0000000000000000000000000000000000000000 70c9a49fdcedbfad87ac23ea6862322578ac4c31 Marcin Grzejszczak <mgrzejszczak@pivotal.io> 1539862036 +0200 clone: from git@github.com:spring-projects/spring-cloud.git

1
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/logs/refs/remotes/origin/HEAD Normal file
View File

@@ -0,0 +1 @@
0000000000000000000000000000000000000000 70c9a49fdcedbfad87ac23ea6862322578ac4c31 Marcin Grzejszczak <mgrzejszczak@pivotal.io> 1539862036 +0200 clone: from git@github.com:spring-projects/spring-cloud.git

BIN
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/objects/pack/pack-7cc9dd9765fae316909a346d62200f0c00f1e86f.idx Normal file
View File

Binary file not shown.

BIN
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/objects/pack/pack-7cc9dd9765fae316909a346d62200f0c00f1e86f.pack Normal file
View File

Binary file not shown.

5
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/packed-refs Normal file
View File

@@ -0,0 +1,5 @@
# pack-refs with: peeled fully-peeled sorted
66f767411e396c28b8ae4ca638824a741e9c2767 refs/remotes/origin/gh-pages
f14c1c0297fbb27491043aef018208adff0523b9 refs/remotes/origin/gh-pages-borked
cad5fcc769356792f511970c41dab283eab2bbd6 refs/remotes/origin/gh-pages-old
70c9a49fdcedbfad87ac23ea6862322578ac4c31 refs/remotes/origin/master

1
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/refs/heads/gh-pages Normal file
View File

@@ -0,0 +1 @@
66f767411e396c28b8ae4ca638824a741e9c2767

1
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/refs/heads/master Normal file
View File

@@ -0,0 +1 @@
70c9a49fdcedbfad87ac23ea6862322578ac4c31

1
spring-cloud-release-tools-spring/src/test/resources/projects/spring-cloud/git/refs/remotes/origin/HEAD Normal file
View File

@@ -0,0 +1 @@
ref: refs/remotes/origin/master