*
*
* public Foo(Bar bar, Baz baz) {
* this.bar = SharedFunctions.requireNonNull(bar, "bar must not be null");
* this.baz = SharedFunctions.requireNonNull(baz, "baz must not be null");
* }
*
*
*
*
* @param obj the object reference to check for nullity
* @param message detail message to be used in the event that a {@code
* NullPointerException} is thrown
* @param * Unlike the method {@link #requireNonNull(Object, String)}, this method allows creation of the message to be deferred until after the null check is made. * While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the * message supplier are less than the cost of just creating the string message directly. *
* * @param obj the object reference to check for nullity * @param messageSupplier supplier of the detail message to be used in the event that a {@code NullPointerException} is thrown * @paramgroupId:artifactId:version:type=sha512.
*/
private final SortedProperties artifactSha512s = new SortedProperties();
/**
* The maven project context injection so that we can get a hold of the variables at hand.
*/
@Parameter(defaultValue = "${project}", required = true)
private MavenProject project;
/**
* The working directory in target that we use as a sandbox for the plugin.
*/
@Parameter(defaultValue = "${project.build.directory}/commons-release-plugin",
property = "commons.outputDirectory")
private File workingDirectory;
/**
* The subversion staging url to which we upload all of our staged artifacts.
*/
@Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")
private String distSvnStagingUrl;
/**
* A parameter to generally avoid running unless it is specifically turned on by the consuming module.
*/
@Parameter(defaultValue = "false", property = "commons.release.isDistModule")
private Boolean isDistModule;
/**
* Constructs a new instance.
*/
public CommonsDistributionDetachmentMojo() {
// empty
}
/**
* A helper method to copy the newly detached artifacts to target/commons-release-plugin
* so that the {@link CommonsDistributionStagingMojo} can find the artifacts later.
*
* @throws MojoExecutionException if some form of an {@link IOException} occurs, we want it
* properly wrapped so that Maven can handle it.
*/
private void copyRemovedArtifactsToWorkingDirectory() throws MojoExecutionException {
final String wdAbsolutePath = workingDirectory.getAbsolutePath();
getLog().info(
"Copying " + detachedArtifacts.size() + " detached artifacts to working directory " + wdAbsolutePath);
for (final Artifact artifact: detachedArtifacts) {
final File artifactFile = artifact.getFile();
final StringBuilder copiedArtifactAbsolutePath = new StringBuilder(wdAbsolutePath);
copiedArtifactAbsolutePath.append("/");
copiedArtifactAbsolutePath.append(artifactFile.getName());
final File copiedArtifact = new File(copiedArtifactAbsolutePath.toString());
getLog().info("Copying: " + artifactFile.getName());
SharedFunctions.copyFile(getLog(), artifactFile, copiedArtifact);
}
}
@Override
public void execute() throws MojoExecutionException {
if (!isDistModule) {
getLog().info("This module is marked as a non distribution or assembly module, and the plugin will not run.");
return;
}
if (StringUtils.isEmpty(distSvnStagingUrl)) {
getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin will not run.");
return;
}
getLog().info("Detaching Assemblies");
for (final Artifact attachedArtifact : project.getAttachedArtifacts()) {
putAttachedArtifactInSha512Map(attachedArtifact);
if (ARTIFACT_TYPES_TO_DETACH.contains(attachedArtifact.getType())) {
detachedArtifacts.add(attachedArtifact);
}
}
if (detachedArtifacts.isEmpty()) {
getLog().info("Current project contains no distributions. Not executing.");
return;
}
//
// PROBLEM CODE for Maven >= 3.8.3
// https://issues.apache.org/jira/browse/MNG-7316
try {
// (1) Try the normal way
// Maven 3.8.3 throws an exception here because MavenProject.getAttachedArtifacts()
// returns an IMMUTABLE collection.
project.getAttachedArtifacts().removeAll(detachedArtifacts);
} catch (final UnsupportedOperationException e) {
// (2) HACK workaround for https://issues.apache.org/jira/browse/MNG-7316
final ArrayListsha512 signature file from a given file.
*
* @param directory is the {@link File} for the directory in which to make the .sha512 file.
* @param file the {@link File} whose name we should use to create the .sha512 file.
* @return a {@link String} that is the absolute path to the .sha512 file.
*/
private String getSha512FilePath(final File directory, final File file) {
final StringBuilder buffer = new StringBuilder(directory.getAbsolutePath());
buffer.append("/");
buffer.append(file.getName());
buffer.append(".sha512");
return buffer.toString();
}
/**
* A helper method that creates sha512 signature files for our detached artifacts in the
* target/commons-release-plugin directory for the purpose of being uploaded by
* the {@link CommonsDistributionStagingMojo}.
*
* @throws MojoExecutionException if some form of an {@link IOException} occurs, we want it
* properly wrapped so that Maven can handle it.
*/
private void hashArtifacts() throws MojoExecutionException {
for (final Artifact artifact : detachedArtifacts) {
if (!StringUtils.toRootLowerCase(artifact.getFile().getName()).contains("asc")) {
final String artifactKey = getArtifactKey(artifact);
try {
final String digest;
// SHA-512
digest = artifactSha512s.getProperty(artifactKey.toString());
getLog().info(artifact.getFile().getName() + " sha512: " + digest);
try (PrintWriter printWriter = new PrintWriter(
getSha512FilePath(workingDirectory, artifact.getFile()))) {
printWriter.println(digest);
}
} catch (final IOException e) {
throw new MojoExecutionException("Could not sign file: " + artifact.getFile().getName(), e);
}
}
}
}
/**
* Takes an attached artifact and puts the signature in the map.
*
* @param artifact is a Maven {@link Artifact} taken from the project at start time of mojo.
* @throws MojoExecutionException if an {@link IOException} occurs when getting the sha512 of the
* artifact.
*/
private void putAttachedArtifactInSha512Map(final Artifact artifact) throws MojoExecutionException {
try {
final String artifactKey = getArtifactKey(artifact);
if (!artifactKey.endsWith(".asc")) { // .asc files don't need hashes
try (InputStream fis = Files.newInputStream(artifact.getFile().toPath())) {
artifactSha512s.put(artifactKey, DigestUtils.sha512Hex(fis));
}
}
} catch (final IOException e) {
throw new MojoExecutionException(
"Could not find artifact signature for: "
+ artifact.getArtifactId()
+ "-"
+ artifact.getClassifier()
+ "-"
+ artifact.getVersion()
+ " type: "
+ artifact.getType(),
e);
}
}
/**
* Writes to ./target/commons-release-plugin/sha512.properties the artifact sha512's.
*
* @throws MojoExecutionException if we can't write the file due to an {@link IOException}.
*/
private void writeAllArtifactsInSha512PropertiesFile() throws MojoExecutionException {
final File propertiesFile = new File(workingDirectory, "sha512.properties");
getLog().info("Writing " + propertiesFile);
try (OutputStream fileWriter = Files.newOutputStream(propertiesFile.toPath())) {
artifactSha512s.store(fileWriter, "Release SHA-512s");
} catch (final IOException e) {
throw new MojoExecutionException("Failure to write SHA-512's", e);
}
}
}
././@LongLink 0100644 0000000 0000000 00000000173 15135430577 011646 L ustar 0000000 0000000 commons-release-plugin-1.9.2-src/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.java commons-release-plugin-1.9.2-src/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistri0100644 0000000 0000000 00000061131 15135430577 034151 0 ustar 00root root 0000000 0000000 /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.release.plugin.mojos;
import java.io.File;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.file.PathUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.Strings;
import org.apache.commons.release.plugin.SharedFunctions;
import org.apache.commons.release.plugin.velocity.HeaderHtmlVelocityDelegate;
import org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.apache.maven.scm.ScmException;
import org.apache.maven.scm.ScmFileSet;
import org.apache.maven.scm.command.add.AddScmResult;
import org.apache.maven.scm.command.checkin.CheckInScmResult;
import org.apache.maven.scm.command.checkout.CheckOutScmResult;
import org.apache.maven.scm.manager.BasicScmManager;
import org.apache.maven.scm.manager.ScmManager;
import org.apache.maven.scm.provider.ScmProvider;
import org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository;
import org.apache.maven.scm.provider.svn.svnexe.SvnExeScmProvider;
import org.apache.maven.scm.repository.ScmRepository;
import org.apache.maven.settings.Settings;
import org.apache.maven.settings.crypto.SettingsDecrypter;
/**
* This class checks out the dev distribution location, copies the distributions into that directory
* structure under the target/commons-release-plugin/scm directory. Then commits the
* distributions back up to SVN. Also, we include the built and zipped site as well as the RELEASE-NOTES.txt.
*
* @since 1.0
*/
@Mojo(name = "stage-distributions",
defaultPhase = LifecyclePhase.DEPLOY,
threadSafe = true,
aggregator = true)
public final class CommonsDistributionStagingMojo extends AbstractMojo {
/** The name of file generated from the README.vm velocity template to be checked into the dist svn repo. */
private static final String README_FILE_NAME = "README.html";
/** The name of file generated from the HEADER.vm velocity template to be checked into the dist svn repo. */
private static final String HEADER_FILE_NAME = "HEADER.html";
/** The name of the signature validation shell script to be checked into the dist svn repo. */
private static final String SIGNATURE_VALIDATOR_NAME = "signature-validator.sh";
/**
* The {@link MavenProject} object is essentially the context of the maven build at
* a given time.
*/
@Parameter(defaultValue = "${project}", required = true)
private MavenProject project;
/**
* The {@link File} that contains a file to the root directory of the working project. Typically
* this directory is where the pom.xml resides.
*/
@Parameter(defaultValue = "${basedir}")
private File baseDir;
/** The location to which the site gets built during running mvn site. */
@Parameter(defaultValue = "${project.build.directory}/site", property = "commons.siteOutputDirectory")
private File siteDirectory;
/**
* The main working directory for the plugin, namely target/commons-release-plugin, but
* that assumes that we're using the default maven ${project.build.directory}.
*/
@Parameter(defaultValue = "${project.build.directory}/commons-release-plugin", property = "commons.outputDirectory")
private File workingDirectory;
/**
* The location to which to check out the dist subversion repository under our working directory, which
* was given above.
*/
@Parameter(defaultValue = "${project.build.directory}/commons-release-plugin/scm",
property = "commons.distCheckoutDirectory")
private File distCheckoutDirectory;
/**
* The location of the RELEASE-NOTES.txt file such that multi-module builds can configure it.
*/
@Parameter(defaultValue = "${basedir}/RELEASE-NOTES.txt", property = "commons.releaseNotesLocation")
private File releaseNotesFile;
/**
* A boolean that determines whether or not we actually commit the files up to the subversion repository.
* If this is set to {@code true}, we do all but make the commits. We do checkout the repository in question
* though.
*/
@Parameter(property = "commons.release.dryRun", defaultValue = "false")
private Boolean dryRun;
/**
* The url of the subversion repository to which we wish the artifacts to be staged. Typically this would need to
* be of the form: scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo/version-RC#. Note. that
* the prefix to the substring https is a requirement.
*/
@Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")
private String distSvnStagingUrl;
/**
* A parameter to generally avoid running unless it is specifically turned on by the consuming module.
*/
@Parameter(defaultValue = "false", property = "commons.release.isDistModule")
private Boolean isDistModule;
/**
* The release version of the artifact to be built.
*/
@Parameter(property = "commons.release.version")
private String commonsReleaseVersion;
/**
* The RC version of the release. For example the first voted on candidate would be "RC1".
*/
@Parameter(property = "commons.rc.version")
private String commonsRcVersion;
/**
* The ID of the server (specified in settings.xml) which should be used for dist authentication.
* This will be used in preference to {@link #username}/{@link #password}.
*/
@Parameter(property = "commons.distServer")
private String distServer;
/**
* The username for the distribution subversion repository. This is typically your Apache id.
*/
@Parameter(property = "user.name")
private String username;
/**
* The password associated with {@link CommonsDistributionStagingMojo#username}.
*/
@Parameter(property = "user.password")
private String password;
/**
* Maven {@link Settings}.
*/
@Parameter(defaultValue = "${settings}", readonly = true, required = true)
private Settings settings;
/**
* Maven {@link SettingsDecrypter} component.
*/
@Component
private SettingsDecrypter settingsDecrypter;
/**
* A subdirectory of the dist directory into which we are going to stage the release candidate. We
* build this up in the {@link CommonsDistributionStagingMojo#execute()} method. And, for example,
* the directory should look like https://dist.apache.org/repos/dist/dev/commons/text/1.4-RC1.
*/
private File distRcVersionDirectory;
/**
* Constructs a new instance.
*/
public CommonsDistributionStagingMojo() {
// empty
}
/**
* Builds up README.html and HEADER.html that reside in following.
* -
*
- distRoot
*
-
*
- binaries/HEADER.html (symlink) *
- binaries/README.html (symlink) *
- source/HEADER.html (symlink) *
- source/README.html (symlink) *
- HEADER.html *
- README.html *
*
-
*
- root:
*
-
*
- site *
- site.zip *
- RELEASE-NOTES.txt *
- source:
*
-
*
- -src artifacts.... *
* - binaries:
*
-
*
- -bin artifacts.... *
*
*
target/commons-release-plugin/scm directory.
* @param provider is the {@link ScmProvider} that we will use for adding the files we wish to commit.
* @param repository is the {@link ScmRepository} that we will use for adding the files that we wish to commit.
* @return a {@link List} of {@link File}'s in the directory for the purpose of adding them to the maven
* {@link ScmFileSet}.
* @throws MojoExecutionException if an {@link IOException} occurs so that Maven can handle it properly.
*/
private ListREADME.html and HEADER.html to the source and binaries
* directories.
*
* @param headerFile The originally created HEADER.html file.
* @param readmeFile The originally created README.html file.
* @return a {@link List} of created files.
* @throws MojoExecutionException if the {@link SharedFunctions#copyFile(Log, File, File)}
* fails.
*/
private ListRELEASE-NOTES.txt file from the base directory of the
* project and copies it into {@link CommonsDistributionStagingMojo#workingDirectory}.
*
* @return the RELEASE-NOTES.txt file that exists in the target/commons-release-notes/scm
* directory for the purpose of adding it to the scm change set in the method
* {@link CommonsDistributionStagingMojo#copyDistributionsIntoScmDirectoryStructureAndAddToSvn(File,
* ScmProvider, ScmRepository)}.
* @throws MojoExecutionException if an {@link IOException} occurs as a wrapper so that maven
* can properly handle the exception.
*/
private File copyReleaseNotesToWorkingDirectory() throws MojoExecutionException {
SharedFunctions.initDirectory(getLog(), distRcVersionDirectory);
getLog().info("Copying RELEASE-NOTES.txt to working directory.");
final File copiedReleaseNotes = new File(distRcVersionDirectory, releaseNotesFile.getName());
SharedFunctions.copyFile(getLog(), releaseNotesFile, copiedReleaseNotes);
return copiedReleaseNotes;
}
/**
* Copies our signature-validator.sh script into
* ${basedir}/target/commons-release-plugin/scm/signature-validator.sh.
*
* @return the {@link File} for the signature-validator.sh
* @throws MojoExecutionException if an error occurs while the resource is being copied
*/
private File copySignatureValidatorScriptToScmDirectory() throws MojoExecutionException {
final Path scmTargetPath = Paths.get(distRcVersionDirectory.toString(), SIGNATURE_VALIDATOR_NAME);
final String name = "/resources/" + SIGNATURE_VALIDATOR_NAME;
// The source can be in a local file or inside a jar file.
try {
PathUtils.copyFile(getClass().getResource(name), scmTargetPath);
} catch (final Exception e) {
throw new MojoExecutionException(String.format("Failed to copy '%s' to '%s'", name, scmTargetPath), e);
}
return scmTargetPath.toFile();
}
/**
* Copies ${basedir}/target/site to ${basedir}/target/commons-release-plugin/scm/site.
*
* @return the {@link List} of {@link File}'s contained in
* ${basedir}/target/commons-release-plugin/scm/site, after the copy is complete.
* @throws MojoExecutionException if the site copying fails for some reason.
*/
private List./target/site directory and compresses it to
* ./target/commons-release-plugin/site.zip.
*
* @since 1.0
* @deprecated As we no longer wish to compress the site, we are going to put this functionality in the
* {@link CommonsDistributionStagingMojo}.
*/
@Deprecated
@Mojo(name = "compress-site",
defaultPhase = LifecyclePhase.POST_SITE,
threadSafe = true,
aggregator = true)
public final class CommonsSiteCompressionMojo extends AbstractMojo {
/**
* The working directory for the plugin which, assuming the maven uses the default
* ${project.build.directory}, this becomes target/commons-release-plugin.
*/
@Parameter(defaultValue = "${project.build.directory}/commons-release-plugin",
property = "commons.outputDirectory")
private File workingDirectory;
/**
* The site output directory.
*/
@Parameter(defaultValue = "${project.build.directory}/site", property = "commons.siteOutputDirectory")
private File siteDirectory;
/**
* The url of the subversion repository to which we wish the artifacts to be staged. Typically
* this would need to be of the form:
* scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo. Note. that the prefix to the
* substring https is a requirement.
*/
@Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")
private String distSvnStagingUrl;
/**
* A parameter to generally avoid running unless it is specifically turned on by the consuming module.
*/
@Parameter(defaultValue = "false", property = "commons.release.isDistModule")
private Boolean isDistModule;
/**
* The list of files to compress into the site.zip file.
*/
private ListdirectoryToZip we add the file to the ZIP archive represented by
* zos.
*
* @param directoryToZip a {@link File} representing the directory from which the file exists that we are
* compressing. Generally this is target/site.
* @param file a {@link File} to add to the {@link ZipOutputStream} zos.
* @param zos the {@link ZipOutputStream} to which to add our file.
* @throws IOException if adding the file doesn't work out properly.
*/
private void addToZip(final File directoryToZip, final File file, final ZipOutputStream zos) throws IOException {
try (InputStream fis = Files.newInputStream(file.toPath())) {
// we want the zipEntry's path to be a relative path that is relative
// to the directory being zipped, so chop off the rest of the path
final String zipFilePath = file.getCanonicalPath().substring(
directoryToZip.getCanonicalPath().length() + 1,
file.getCanonicalPath().length());
final ZipEntry zipEntry = new ZipEntry(zipFilePath);
zos.putNextEntry(zipEntry);
IOUtils.copy(fis, zos);
}
}
@Override
public void execute() throws MojoExecutionException, MojoFailureException {
if (!isDistModule) {
getLog().info("This module is marked as a non distribution "
+ "or assembly module, and the plugin will not run.");
return;
}
if (StringUtils.isEmpty(distSvnStagingUrl)) {
getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin will not run.");
return;
}
if (!siteDirectory.exists()) {
getLog().error("\"mvn site\" was not run before this goal, or a siteDirectory did not exist.");
throw new MojoFailureException(
"\"mvn site\" was not run before this goal, or a siteDirectory did not exist."
);
}
if (!workingDirectory.exists()) {
getLog().info("Current project contains no distributions. Not executing.");
return;
}
try {
filesToCompress = new ArrayList<>();
getAllSiteFiles(siteDirectory, filesToCompress);
writeZipFile(workingDirectory, siteDirectory, filesToCompress);
} catch (final IOException e) {
getLog().error("Failed to create ./target/commons-release-plugin/site.zip: " + e.getMessage(), e);
throw new MojoExecutionException(
"Failed to create ./target/commons-release-plugin/site.zip: " + e.getMessage(),
e
);
}
}
/**
* By default this method iterates across the target/site directory and adds all the files
* to the {@link CommonsSiteCompressionMojo#filesToCompress} {@link List}.
*
* @param siteDirectory the {@link File} that represents the target/site directory.
* @param filesToCompress the {@link List} to which to add all the files.
*/
private void getAllSiteFiles(final File siteDirectory, final ListfileList to a site.zip file
* in the workingDirectory.
*
* @param outputDirectory is a {@link File} representing the place to put the site.zip file.
* @param directoryToZip is a {@link File} representing the directory of the site (normally
* target/site).
* @param fileList the list of files to be zipped up, generally generated by
* {@link CommonsSiteCompressionMojo#getAllSiteFiles(File, List)}.
* @throws IOException when the copying of the files goes incorrectly.
*/
private void writeZipFile(final File outputDirectory, final File directoryToZip, final Listtarget/commons-release-plugin, but
* that assumes that we're using the default maven ${project.build.directory}.
*/
@Parameter(defaultValue = "${project.build.directory}/commons-release-plugin", property = "commons.outputDirectory")
private File workingDirectory;
/**
* The location to which to checkout the dist subversion repository under our working directory, which
* was given above. We then do an SVN delete on all the directories in this repository.
*/
@Parameter(defaultValue = "${project.build.directory}/commons-release-plugin/scm-cleanup",
property = "commons.distCleanupDirectory")
private File distCleanupDirectory;
/**
* A boolean that determines whether or not we actually commit the files up to the subversion repository.
* If this is set to {@code true}, we do all but make the commits. We do checkout the repository in question
* though.
*/
@Parameter(property = "commons.release.dryRun", defaultValue = "false")
private Boolean dryRun;
/**
* The url of the subversion repository to which we wish the artifacts to be staged. Typically this would need to
* be of the form: scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo/version-RC#. Note. that
* the prefix to the substring https is a requirement.
*/
@Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")
private String distSvnStagingUrl;
/**
* A parameter to generally avoid running unless it is specifically turned on by the consuming module.
*/
@Parameter(defaultValue = "false", property = "commons.release.isDistModule")
private Boolean isDistModule;
/**
* The ID of the server (specified in settings.xml) which should be used for dist authentication.
* This will be used in preference to {@link #username}/{@link #password}.
*/
@Parameter(property = "commons.distServer")
private String distServer;
/**
* The username for the distribution subversion repository. This is typically your Apache id.
*/
@Parameter(property = "user.name")
private String username;
/**
* The password associated with {@link CommonsDistributionStagingMojo#username}.
*/
@Parameter(property = "user.password")
private String password;
/**
* Maven {@link Settings}.
*/
@Parameter(defaultValue = "${settings}", readonly = true, required = true)
private Settings settings;
/**
* Maven {@link SettingsDecrypter} component.
*/
@Component
private SettingsDecrypter settingsDecrypter;
/**
* Constructs a new instance.
*/
public CommonsStagingCleanupMojo() {
// empty
}
@Override
public void execute() throws MojoExecutionException, MojoFailureException {
if (!isDistModule) {
getLog().info("This module is marked as a non distribution "
+ "or assembly module, and the plugin will not run.");
return;
}
if (StringUtils.isEmpty(distSvnStagingUrl)) {
getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin will not run.");
return;
}
if (!workingDirectory.exists()) {
SharedFunctions.initDirectory(getLog(), workingDirectory);
}
try {
final ScmManager scmManager = new BasicScmManager();
scmManager.setScmProvider("svn", new SvnExeScmProvider());
final ScmRepository repository = scmManager.makeScmRepository(distSvnStagingUrl);
final ScmProvider provider = scmManager.getProviderByRepository(repository);
final SvnScmProviderRepository providerRepository = (SvnScmProviderRepository) repository
.getProviderRepository();
SharedFunctions.setAuthentication(
providerRepository,
distServer,
settings,
settingsDecrypter,
username,
password
);
getLog().info("Checking out dist from: " + distSvnStagingUrl);
final ScmFileSet scmFileSet = new ScmFileSet(distCleanupDirectory);
final CheckOutScmResult checkOutResult = provider.checkOut(repository, scmFileSet);
if (!checkOutResult.isSuccess()) {
throw new MojoExecutionException("Failed to checkout files from SCM: "
+ checkOutResult.getProviderMessage() + " [" + checkOutResult.getCommandOutput() + "]");
}
final List-
*
- {@link org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo}, *
- {@link org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo}, and *
- {@link org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo} *
-
*
- {@link org.apache.commons.release.plugin.SharedFunctions} *
HEADER.html that moves along with the
* release for the sake of downloading the release from the distribution area.
*
* @since 1.3
*/
public final class HeaderHtmlVelocityDelegate {
/**
* A builder class for instantiation of the {@link HeaderHtmlVelocityDelegate}.
*/
public static final class HeaderHtmlVelocityDelegateBuilder {
/**
* Private constructor so that we can have a proper builder pattern.
*/
private HeaderHtmlVelocityDelegateBuilder() {
}
/**
* Builds up the {@link ReadmeHtmlVelocityDelegate} from the previously set parameters.
*
* @return a new {@link ReadmeHtmlVelocityDelegate}.
*/
public HeaderHtmlVelocityDelegate build() {
return new HeaderHtmlVelocityDelegate();
}
}
/** The location of the velocity template for this class. */
private static final String TEMPLATE = "resources/org/apache/commons/release/plugin/velocity/HEADER.vm";
/**
* For instantiating our {@link HeaderHtmlVelocityDelegate} using the {@link HeaderHtmlVelocityDelegateBuilder}.
*
* @return a {@link HeaderHtmlVelocityDelegateBuilder}.
*/
public static HeaderHtmlVelocityDelegateBuilder builder() {
return new HeaderHtmlVelocityDelegateBuilder();
}
/** The private constructor to be used by the {@link HeaderHtmlVelocityDelegateBuilder}. */
private HeaderHtmlVelocityDelegate() {
}
/**
* Builds the HEADER.vm velocity template to the writer passed in.
*
* @param writer any {@link Writer} that we wish to have the filled velocity template written to.
* @return the {@link Writer} that we've filled out the template into.
*/
public Writer render(final Writer writer) {
final VelocityEngine ve = new VelocityEngine();
ve.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");
ve.setProperty("classpath.resource.loader.class", ClasspathResourceLoader.class.getName());
ve.init();
final Template template = ve.getTemplate(TEMPLATE);
final VelocityContext context = new VelocityContext();
template.merge(context, writer);
return writer;
}
}
././@LongLink 0100644 0000000 0000000 00000000172 15135430577 011645 L ustar 0000000 0000000 commons-release-plugin-1.9.2-src/src/main/java/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.java commons-release-plugin-1.9.2-src/src/main/java/org/apache/commons/release/plugin/velocity/ReadmeHtml0100644 0000000 0000000 00000015665 15135430577 034123 0 ustar 00root root 0000000 0000000 /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.release.plugin.velocity;
import java.io.Writer;
import org.apache.commons.lang3.StringUtils;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.VelocityEngine;
import org.apache.velocity.runtime.RuntimeConstants;
import org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;
/**
* This class' purpose is to generate the README.html that moves along with the
* release for the sake of downloading the release from the distribution area.
*
* @since 1.3
*/
public final class ReadmeHtmlVelocityDelegate {
/**
* A builder class for instantiation of the {@link ReadmeHtmlVelocityDelegate}.
*/
public static final class ReadmeHtmlVelocityDelegateBuilder {
/** The maven artifactId to use in the README.vm template. */
private String artifactId;
/** The maven version to use in the README.vm template. */
private String version;
/** The site url to use in the README.vm template. */
private String siteUrl;
/**
* Private constructor for using the builder through the {@link ReadmeHtmlVelocityDelegate#builder()}
* method.
*/
private ReadmeHtmlVelocityDelegateBuilder() {
}
/**
* Builds up the {@link ReadmeHtmlVelocityDelegate} from the previously set parameters.
*
* @return a new {@link ReadmeHtmlVelocityDelegate}.
*/
public ReadmeHtmlVelocityDelegate build() {
return new ReadmeHtmlVelocityDelegate(this.artifactId, this.version, this.siteUrl);
}
/**
* Adds the artifactId to the {@link ReadmeHtmlVelocityDelegate}.
*
* @param artifactId the {@link String} representing the maven artifactId.
* @return the builder to continue building.
*/
public ReadmeHtmlVelocityDelegateBuilder withArtifactId(final String artifactId) {
this.artifactId = artifactId;
return this;
}
/**
* Adds the siteUrl to the {@link ReadmeHtmlVelocityDelegate}.
*
* @param siteUrl the site url to be used in the README.html
* @return the builder to continue building.
*/
public ReadmeHtmlVelocityDelegateBuilder withSiteUrl(final String siteUrl) {
this.siteUrl = siteUrl;
return this;
}
/**
* Adds the version to the {@link ReadmeHtmlVelocityDelegate}.
*
* @param version the maven version.
* @return the builder to continue building.
*/
public ReadmeHtmlVelocityDelegateBuilder withVersion(final String version) {
this.version = version;
return this;
}
}
/** The location of the velocity template for this class. */
private static final String TEMPLATE = "resources/org/apache/commons/release/plugin"
+ "/velocity/README.vm";
/**
* Gets the {@link ReadmeHtmlVelocityDelegateBuilder} for constructing the {@link ReadmeHtmlVelocityDelegate}.
*
* @return the {@link ReadmeHtmlVelocityDelegateBuilder}.
*/
public static ReadmeHtmlVelocityDelegateBuilder builder() {
return new ReadmeHtmlVelocityDelegateBuilder();
}
/** This is supposed to represent the maven artifactId. */
private final String artifactId;
/** This is supposed to represent the maven version of the release. */
private final String version;
/** The url of the site that gets set into the README.html. */
private final String siteUrl;
/**
* The private constructor to be used by the {@link ReadmeHtmlVelocityDelegateBuilder}.
*
* @param artifactId sets the {@link ReadmeHtmlVelocityDelegate#artifactId}.
* @param version sets the {@link ReadmeHtmlVelocityDelegate#version}.
* @param siteUrl sets the {@link ReadmeHtmlVelocityDelegate#siteUrl}.
*/
private ReadmeHtmlVelocityDelegate(final String artifactId, final String version, final String siteUrl) {
this.artifactId = artifactId;
this.version = version;
this.siteUrl = siteUrl;
}
/**
* Renders the README.vm velocity template with the variables constructed with the
* {@link ReadmeHtmlVelocityDelegateBuilder}.
*
* @param writer is the {@link Writer} to which we wish to render the README.vm template.
* @return a reference to the {@link Writer} passed in.
*/
public Writer render(final Writer writer) {
final VelocityEngine ve = new VelocityEngine();
ve.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");
ve.setProperty("classpath.resource.loader.class", ClasspathResourceLoader.class.getName());
ve.init();
final Template template = ve.getTemplate(TEMPLATE);
final String[] splitArtifactId = artifactId.split("-");
final String wordCommons = "commons";
String artifactShortName = "";
if (splitArtifactId.length > 1) {
artifactShortName = splitArtifactId[1];
} else if (splitArtifactId.length == 1) {
artifactShortName = splitArtifactId[0];
}
// ".+\\d$" matches a non-empty string that terminates in a digit {0-9}.
if (artifactShortName.matches(".+\\d$")) {
artifactShortName = artifactShortName.substring(0, artifactShortName.length() - 1);
}
final String artifactIdWithFirstLetterscapitalized =
StringUtils.capitalize(wordCommons)
+ "-"
+ artifactShortName.toUpperCase();
final VelocityContext context = new VelocityContext();
context.internalPut("artifactIdWithFirstLetterscapitalized", artifactIdWithFirstLetterscapitalized);
context.internalPut("artifactShortName", artifactShortName.toUpperCase());
context.internalPut("artifactId", artifactId);
context.internalPut("version", version);
context.internalPut("siteUrl", siteUrl);
template.merge(context, writer);
return writer;
}
}
././@LongLink 0100644 0000000 0000000 00000000154 15135430577 011645 L ustar 0000000 0000000 commons-release-plugin-1.9.2-src/src/main/java/org/apache/commons/release/plugin/velocity/package-info.java commons-release-plugin-1.9.2-src/src/main/java/org/apache/commons/release/plugin/velocity/package-in0100644 0000000 0000000 00000002243 15135430577 034064 0 ustar 00root root 0000000 0000000 /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Contains classes that take our velocity templates and render's them to a {@link java.io.Writer}
* class.
* * The main reason for velocity templates are to fill out the following files that get deployed alongside: *
-
*
HEADER.html
* README.html
*
Apache Commons Project Distributions
The most recent source and binary releases for the Apache Commons project are available from this directory listing. For older releases, please use the archives.
Important Notices
././@LongLink 0100644 0000000 0000000 00000000151 15135430577 011642 L ustar 0000000 0000000 commons-release-plugin-1.9.2-src/src/main/resources/org/apache/commons/release/plugin/velocity/README.vm commons-release-plugin-1.9.2-src/src/main/resources/org/apache/commons/release/plugin/velocity/READM0100644 0000000 0000000 00000005212 15135430577 034005 0 ustar 00root root 0000000 0000000${artifactIdWithFirstLetterscapitalized} v${version}.
This is the ${version} version of ${artifactId}. It is available in both binary and source distributions.
Note: The tar files in the distribution use GNU tar extensions and must be untarred with a GNU compatible version of tar. The version of tar on Solaris and Mac OS X will not work with these files
Changes
The changes in this release are detailed in the release notes.
Thank you for using ${artifactShortName}.
From the Apache Commons Project
https://commons.apache.org/
Download from your nearest mirror site!
Do not download from www.apache.org. Please use a mirror site to help us save apache.org bandwidth. Go here to find your nearest mirror.
Signatures
Many of the files have been digitally signed using GnuPG. If so, there will be an accompanying file.asc signature file in the same directory as the file (binaries/ or source/). The signing keys can be found in the distribution directory at <http://downloads.apache.org/commons/KEYS>.
Always download the KEYS file directly from the Apache site, never from a mirror site.
Always test available signatures, e.g.,
$ pgpk -a KEYS
$ pgpv ${artifactId}-${version}-bin.tar.gz.asc
or,
$ pgp -ka KEYS
$ pgp ${artifactId}-${version}-bin.tar.gz.asc
or,
$ gpg --import KEYS
$ gpg --verify ${artifactId}-${version}-bin.tar.gz.asc
commons-release-plugin-1.9.2-src/src/main/resources/signature-validator.sh 0100755 0000000 0000000 00000013077 15135430577 027326 0 ustar 00root root 0000000 0000000 #!/bin/bash -x
###########
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
###########
# DOCUMENTATION.
# This script is to be placed in the root of the svn dist checkout.
# For example, my directory looks like:
#
# drwxr-xr-x@ 8 usr staff 256 Oct 1 11:22 .svn
# -rw-r--r--@ 1 usr staff 1230 Oct 1 11:22 HEADER.html
# -rw-r--r--@ 1 usr staff 2649 Oct 1 11:22 README.html
# -rw-r--r--@ 1 usr staff 5093 Oct 1 11:22 RELEASE-NOTES.txt
# drwxr-xr-x@ 10 usr staff 320 Oct 1 11:22 binaries
# -rw-r--r--@ 1 usr staff 3900 Oct 1 13:40 signature-validation.sh
# drwxr-xr-x@ 44 usr staff 1408 Oct 1 11:22 site
# drwxr-xr-x@ 10 usr staff 320 Oct 1 11:37 source
#
# From here you run ./signature-validation.sh and it will create a directory "artifacts-for-validation-deletable-post-validation
# in which all of the binaries generated by a release are copied and then it checks to see that all of the signatures and hashes
# are infact correct for the artifacts.
#
###########
if test "$#" != "1"
then
echo "ERROR:"
echo "We expect the a url like https://repository.apache.org/content/repositories/orgapachecommons-1531/commons-net/commons-net/3.7.1/"
echo "to be passed in as a parameter to the script."
fi
BASEDIR="$( cd "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
VALIDATION_DIR=${BASEDIR}/artifacts-for-validation-deletable-post-validation
BINARIES_DIR=${BASEDIR}/binaries
SOURCE_DIR=${BASEDIR}/source
BASE_NEXUS_URL="$1"
function clean_and_build_validation_dir() {
mkdir -p ${VALIDATION_DIR}
}
function copy_in_checked_out_artifacts() {
cp ${BASEDIR}/binaries/commons* ${VALIDATION_DIR}
cp ${BASEDIR}/source/commons* ${VALIDATION_DIR}
}
function download_nexus_artifacts_to_validation_directory() {
# Curls html page and does text modification to put artifacts in semicolon delimited list
# ...(ugly but works, debug by removing pipes one at a time)
echo "INFO: Downloading artifacts from nexus"
echo ${BASE_NEXUS_URL}
NEXUS_ARTIFACTS=$(curl ${BASE_NEXUS_URL} \
| grep "${BASE_NEXUS_URL}" \
| cut -d '>' -f3 \
| sed "s| /dev/null 2>&1
if test "$?" != "0"
then
echo "$element failed gpg signature check"
exit 1;
fi
fi
done
echo "SUCCESSFUL VALIDATION"
}
function clean_up_afterwards() {
rm -rf ${VALIDATION_DIR}
}
echo $(clean_and_build_validation_dir)
echo $(copy_in_checked_out_artifacts)
echo $(download_nexus_artifacts_to_validation_directory)
echo $(validate_signatures)
#clean_up_afterwards
commons-release-plugin-1.9.2-src/src/main/scripts/generate-xdocs.build.xml 0100644 0000000 0000000 00000017077 15135430577 027214 0 ustar 00root root 0000000 0000000
The best sources of information are
Developing Java Plugins for Maven 3.x
and Maven: The Definitive Guide: Chapter 11 Writing Plugins.
Each Mojo is a java file that extends
The variables in the mojo that are declared as private with the annotations
We've declared mock maven poms in the
Maven ships with a debugger under the hood. It is suggested that you have a sandbox project in which you can
run the goals or the plugin configuration. Once you have that set up you can run something like
We recommend you use a mirror to download our release
builds, but you must verify the integrity of
the downloaded files using signatures downloaded from our main
distribution directories. Recent releases (48 hours) may not yet
be available from all the mirrors.
You are currently using [preferred]. If you
encounter a problem with this mirror, please select another
mirror. If all mirrors are failing, there are backup
mirrors (at the end of the mirrors list) that should be
available.
It is essential that you
verify the integrity
of downloaded files, preferably using the
The KEYS
file contains the public PGP keys used by Apache Commons developers
to sign releases.
Older releases can be obtained from the archives.
This is a Maven 3.x Plugin which is
used by Apache Commons releases. See
the Development page for information to
help maintain this plugin.
The main purpose of the plugin is to automate the steps of our, namely
The Apache Commons Project's, release process. Currently we have the mechanics
for detaching distribution artifacts (i.e. all
Available Goals (which are meant to be used together; the only reason they are separated is for
code readability):
Configure the plugin as the last plugin in the This is now done in the Commons Parent POM, so is not needed in the component POM.
The following properties need to be defined in the component POM if not already defined
Ensure your Release Manager details are defined in your Maven
After the above configuration performing the release would occur by (note. more
in depth details can be found at
Preparations For A Release):
To avoid specifying distribution credentials at the command
line, consider using the
If the component is new, then, before running this maven command, you would want to create
the requisite subversion directory
Apache Commons Release Plugin uses ASF JIRA for tracking issues.
See the Apache Commons Release Plugin JIRA project page.
To use JIRA you may need to create an account
(if you have previously created/updated Commons issues using Bugzilla an account will have been automatically
created and you can use the Forgot Password
page to get a new password).
If you would like to report a bug, or raise an enhancement request with
Apache Commons Release Plugin please do the following:
Please also remember these points:
For more information on creating patches see the
Apache Contributors Guide.
You may also find these links useful:
Apache Commons Release Plugin shares mailing lists with all the other
Commons Components.
To make it easier for people to only read messages related to components they are interested in,
the convention in Commons is to prefix the subject line of messages with the component's name,
for example:
Questions related to the usage of Apache Commons Release Plugin should be posted to the
User List.
Note: please don't send patches or attachments to any of the mailing lists;
most of the lists are set up to drop attachments.
Patches are best handled via the Issue Tracking system.
If you have a GitHub account, most components also accept PRs (pull requests).
Otherwise, please upload the file to a public server and include the URL in the mail.
Please prefix the subject line of any messages for Apache Commons Release Plugin
with [release-plugin] - thanks!
Other mailing lists which you may find useful include:
The
Note: The VOTE.txt should be regenerated before every release candidate.
This goal uses the following:
To generate a VOTE.txt, the following properties are configured in the component's
Example configuration for Commons Chain:
1 Wl!AbstractMojo that contains an annotation specifying
the goal name for the mojo and the maven lifecycle phase that it executes under by default. For, example
commons-release:detach-distributions that is to occur during the VERIFY maven
lifecycle.
@Parameter get
imported to the Mojo by the existent maven variables or the declared <configuration>. For
example, we have a boolean variable named dryRun declared as:
property here (as in the 1.1 release), you can, on the command line,
use the following -Dcommons.release.dryRun=true.
resources directory of the src/test folder,
under which we've stored in subdirectories corresponding to the names of the mojos that they are testing. All
variables that you wish to be available to your mojo must be specifically declared in the mock pom file. For
example, we need to use the already existent MavenProject in the maven runtime by instead, in a
test package declaring a class extending MavenProjectStub that returns values we wish to be used
in testing. We then add this to our pom in the following declaration of the plugin:
MojoRule in our test class,
File pointed to the path of the mock pom, and then
making the following call:
compress-site goal.
[if-any logo][end]
PGP signature (*.asc files);
failing that using the SHA512 hash (*.sha512 checksum files).
commons-release-plugin-1.9.2-bin.tar.gz
sha512
pgp
commons-release-plugin-1.9.2-bin.zip
sha512
pgp
commons-release-plugin-1.9.2-src.tar.gz
sha512
pgp
commons-release-plugin-1.9.2-src.zip
sha512
pgp
tar.gz artifacts and
signatures as well as all .zip artifacts and signatures), creating
a site.zip file, and staging all of those artifacts in a subversion
repository (for the most part a subdirectory of
https://dist.apache.org/repos/dist/dev/commons/.
It can, however, stage to any subversion repository.
tar.gz, tar.gz.asc, zip, and zip.asc
files from being uploaded to nexus and copy them to the target/commons-release-plugin
directory.
target/commons-release-plugin directory, and the RELEASE-NOTES.txt from
the root of the project, and commit them to a specified staging subversion repository.
<build> section of the pom.xml
~/.m2/settings.xml file
(These are used by the vote-txt goal)
Properties have to be defined in a profile. For example:
distServer plugin configuration parameter (property commons.distServer)
to specify a server definition in Maven settings.xml which defines your (encrypted, right?) authentication info.
https://dist.apache.org/repos/dist/dev/commons/foo. Notice,
that the way to perform a dry run of the release you need to include
-Dcommons.release.dryRun=true -Ptest-deploy.
The Developer List
is for questions and discussion related to the development of Apache Commons Release Plugin.
Please do not cross-post; developers are also subscribed to the user list.
You must be subscribed to post to the mailing lists. Follow the Subscribe links below
to subscribe.
Name
Subscribe
Unsubscribe
Post
Archive
Other Archives
Commons User List
Questions on using Apache Commons Release Plugin.
Subscribe
Unsubscribe
Post
lists.apache.org
www.mail-archive.com
Commons Developer List
Discussion of development of Apache Commons Release Plugin.
Subscribe
Unsubscribe
Post
lists.apache.org
www.mail-archive.com
Commons Issues List
Only for e-mails automatically generated by the issue tracking system.
Subscribe
Unsubscribe
read only
lists.apache.org
www.mail-archive.com
Commons Commits List
Only for e-mails automatically generated by the source control system.
Subscribe
Unsubscribe
read only
lists.apache.org
www.mail-archive.com
Name
Subscribe
Unsubscribe
Post
Archive
Other Archives
Apache Announce List
General announcements of Apache project releases.
Subscribe
Unsubscribe
read only
lists.apache.org
www.mail-archive.com
commons-release:vote-txt goal generates a VOTE.txt file for a component.
Execute the goal using the following command:
vote-txt mojo definition in the
generate-xdocs.mojos.xml mapping documentvote-txt target in
generate-xdocs.build.xml
ant scriptpom.xml
src/test/resources/detach-distributions/detach-distributions.xml for the declared
* usage of
* this class.
*
* @since 1.0
*/
public final class DistributionDetachmentProjectStub extends MavenProjectStub {
public static final class DistributionDetachmentArtifactStub extends ArtifactStub {
private final File artifact;
private final String version;
private final String classifier;
private final String type;
public DistributionDetachmentArtifactStub(final File file, final String type, final String groupId,
final String artifactId, final String classifier, final String version) {
this.setArtifactId(artifactId);
this.setGroupId(groupId);
this.setArtifactHandler(new DefaultArtifactHandlerStub(type, classifier));
this.artifact = file;
this.type = type;
this.classifier = classifier;
this.version = version;
}
@Override
public String getClassifier() {
return this.classifier;
}
@Override
public File getFile() {
return this.artifact;
}
@Override
public String getType() {
return this.type;
}
@Override
public String getVersion() {
return this.version;
}
}
private Listsrc/test/resources
* directory of the project in the implementation block of the declaration of the configuration
* property. The maven unit testing framework then wires this stubbed object into the appropriate mojo
* for testing purposes.
*
* @since 1.0
*/
package org.apache.commons.release.plugin.stubs;
././@LongLink 0100644 0000000 0000000 00000000176 15135430577 011651 L ustar 0000000 0000000 commons-release-plugin-1.9.2-src/src/test/java/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegateTest.java commons-release-plugin-1.9.2-src/src/test/java/org/apache/commons/release/plugin/velocity/HeaderHtml0100644 0000000 0000000 00000002702 15135430577 034135 0 ustar 00root root 0000000 0000000 /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.release.plugin.velocity;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
import org.junit.jupiter.api.Test;
/**
* Unit tests for {@link HeaderHtmlVelocityDelegate}.
*/
class HeaderHtmlVelocityDelegateTest {
@Test
void testSuccess() throws IOException {
final HeaderHtmlVelocityDelegate subject = HeaderHtmlVelocityDelegate.builder().build();
try (Writer writer = subject.render(new StringWriter())) {
assertTrue(writer.toString().contains("Apache Commons Project Distributions
"));
}
}
}
././@LongLink 0100644 0000000 0000000 00000000176 15135430577 011651 L ustar 0000000 0000000 commons-release-plugin-1.9.2-src/src/test/java/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegateTest.java commons-release-plugin-1.9.2-src/src/test/java/org/apache/commons/release/plugin/velocity/ReadmeHtml0100644 0000000 0000000 00000005376 15135430577 034154 0 ustar 00root root 0000000 0000000 /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.release.plugin.velocity;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
import org.junit.jupiter.api.Test;
/**
* Unit tests for {@link ReadmeHtmlVelocityDelegate}.
*/
final class ReadmeHtmlVelocityDelegateTest {
@Test
void testSuccessfulRun() throws IOException {
final ReadmeHtmlVelocityDelegate delegate = ReadmeHtmlVelocityDelegate.builder()
.withArtifactId("commons-text")
.withVersion("1.4")
.withSiteUrl("https://commons.apache.org/text")
.build();
try (Writer writer = delegate.render(new StringWriter())) {
final String filledOutTemplate = writer.toString();
assertTrue(filledOutTemplate.contains("Commons-TEXT v1.4.
"));
}
}
@Test
void testSuccessfulRunBcel() throws IOException {
final ReadmeHtmlVelocityDelegate delegate = ReadmeHtmlVelocityDelegate.builder()
.withArtifactId("bcel")
.withVersion("1.5")
.withSiteUrl("https://commons.apache.org/text")
.build();
try (Writer writer = delegate.render(new StringWriter())) {
final String filledOutTemplate = writer.toString();
assertTrue(filledOutTemplate.contains("Commons-BCEL v1.5.
"));
}
}
@Test
void testSuccessfulRunLang3() throws IOException {
final ReadmeHtmlVelocityDelegate delegate = ReadmeHtmlVelocityDelegate.builder()
.withArtifactId("commons-lang3")
.withVersion("3.8.1")
.withSiteUrl("https://commons.apache.org/text")
.build();
try (Writer writer = delegate.render(new StringWriter())) {
final String filledOutTemplate = writer.toString();
assertTrue(filledOutTemplate.contains("Commons-LANG v3.8.1.
"));
}
}
}
commons-release-plugin-1.9.2-src/src/test/resources/mojos/compress-site/compress-site-disabled.xml 0100644 0000000 0000000 00000004023 15135430577 034035 0 ustar 00root root 0000000 0000000
K v%8%T \ *͟ 2uI/mj'< iu/ct|ou=ccL@cv=6 .moDzlz5N_M6TC٢V4y+s$Epa-~C02=~4s'%p#*{HǒwR p>Wj thU?9-.Ʃ}(F(]TBbE
I N1
]3\ư%f&f/1.b}v\U %0cˊ n$I^A$A˴y? ٝ g{=7.ʞ%эW!Ll &{j ΰf1#Yڟ:ḧ́5
Ki
FOȆ+#s78Rn(9=!+ Iv¥f.d}Mu?*v[_?IYIg8-K jR\r>*5 lZw d/cAL'u
R
uakVUB=oÝ;"#s1s+6kr
UL]DP@ևa} W j,s+I̸&)`-4 g
@[u Xa=uD`ˬrdu8 f Ksʉu@QiAY ln@k#P=%\|ܵ4fڃDt=.ΔtSpnJ:#>s&SCu$Hъ/"ސ2V[u lٞ+* LՕNLV~ R[ K5kiQ._.E,z"'*Rn X:A˗B
BbV?~bJZO"0&8ګ7u9`ց`2DvѰ^e$! @Ɓ;S4ߴ>'ԧeO1$1Ӥ4ID;E X.i2Z8B 7&}^MA^OmaD))T 9*UyJl\ZϷ ;?MCȜTcQbqNę.?(p`[:F^ !t
kG?x's* ll:?d-pv
-61ޞ43vMe otTm$)mL@cZ IH-PjN4YDo0_<K%aģ@Hā>f&9?:TUҒ|+UJ¼E 3kֿr)
qBBBi[m'6gJ <EV ;;k