com.atlassian.maven.jgitflow.api.example.UpdateReadmeExtension Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jgitflow-maven-api Show documentation
An API to allow maven projects to extend the jgitflow-maven-plugin
The newest version!
package com.atlassian.maven.jgitflow.api.example;

/*-
 * #%L
 * JGitFlow :: Maven API
 * %%
 * Copyright (C) 2017 Atlassian Pty, LTD, Ultreia.io
 * %%
 * Licensed 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
 * 
 *      http://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.
 * #L%
 */

import java.io.File;

import com.atlassian.jgitflow.core.JGitFlowInfo;
import com.atlassian.maven.jgitflow.api.exception.MavenJGitFlowExtensionException;
import com.atlassian.maven.jgitflow.api.impl.NoopMavenReleaseFinishExtension;
import com.atlassian.maven.jgitflow.api.util.JGitFlowCommitHelper;

import com.google.common.base.Charsets;
import com.google.common.io.Files;

import org.eclipse.jgit.api.Git;

/**
 * An example class meant to be used on release-finish to update a README.md file with the new release version
 */
public class UpdateReadmeExtension extends NoopMavenReleaseFinishExtension
{

    public static final String README_MD = "README.md";

    /**
     * Updates the README.md file on release-finish with the new release version.
     * Since the change happens on master first and is then back-merged into develop, we only need to change the file when master is updated.
     *
     * @param newVersion
     * @param oldVersion
     * @param flow
     * @throws MavenJGitFlowExtensionException
     */
    @Override
    public void onMasterBranchVersionChange(String newVersion, String oldVersion, JGitFlowInfo flow) throws MavenJGitFlowExtensionException
    {
        try
        {
            Git git = flow.git();

            //get the README.md file
            File readmeFile = new File(flow.getProjectRoot(), README_MD);

            //do the replacement
            //NOTE: This is not performant or scalable. It's only here for example purposes.
            String readmeContent = Files.toString(readmeFile, Charsets.UTF_8);
            String newContent = readmeContent.replace(oldVersion, newVersion);

            Files.write(newContent, readmeFile, Charsets.UTF_8);

            //now commit the change
            JGitFlowCommitHelper.commitAllChanges(flow, "updating version in README.md");

        }
        catch (Exception e)
        {
            throw new MavenJGitFlowExtensionException("Error updating " + README_MD + " file!", e);
        }
    }
}