org.jreleaser.engine.release.ChangelogResolver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jreleaser-engine Show documentation
JReleaser Engine
The newest version!
/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * Copyright 2020-2024 The JReleaser authors.
 *
 * 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
 *
 *     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.jreleaser.engine.release;

import org.jreleaser.bundle.RB;
import org.jreleaser.engine.changelog.Changelog;
import org.jreleaser.model.Constants;
import org.jreleaser.model.internal.JReleaserContext;
import org.jreleaser.model.internal.release.BaseReleaser;
import org.jreleaser.model.internal.release.Changelog.Append;
import org.jreleaser.mustache.TemplateContext;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;

import static java.lang.System.lineSeparator;
import static java.nio.charset.StandardCharsets.UTF_8;
import static java.nio.file.StandardOpenOption.CREATE_NEW;
import static java.nio.file.StandardOpenOption.WRITE;
import static org.jreleaser.mustache.MustacheUtils.applyTemplate;
import static org.jreleaser.mustache.MustacheUtils.passThrough;
import static org.jreleaser.util.StringUtils.isNotBlank;
import static org.jreleaser.util.StringUtils.stripMargin;

/**
 * @author Andres Almiray
 * @since 1.5.0
 */
public class ChangelogResolver {
    private static final String JRELEASER_CHANGELOG_ANCHOR = "";

    private ChangelogResolver() {
        // noop
    }

    public static void resolve(JReleaserContext context) {
        String resolvedChangelog = Changelog.createChangelog(context);
        context.getChangelog().setResolvedChangelog(resolvedChangelog);

        if (isNotBlank(resolvedChangelog) &&
            context.getModel().getProject().isRelease() &&
            context.getModel().getRelease().getReleaser().getChangelog().getAppend().isEnabled()) {
            appendChangelog(context, resolvedChangelog);
        }
    }

    private static void appendChangelog(JReleaserContext context, String resolvedChangelog) {
        BaseReleaser releaser = context.getModel().getRelease().getReleaser();
        Append append = releaser.getChangelog().getAppend();

        TemplateContext props = context.fullProps();
        String resolvedTitle = applyTemplate(append.getTitle(), props);

        props.set(Constants.KEY_CHANGELOG_TITLE, passThrough(resolvedTitle));
        props.set(Constants.KEY_CHANGELOG_CONTENT, passThrough(resolvedChangelog));
        props.set(Constants.KEY_CHANGELOG_CHANGES, passThrough(context.getChangelog().getFormattedChanges()));
        props.set(Constants.KEY_CHANGELOG_CONTRIBUTORS, passThrough(context.getChangelog().getFormattedContributors()));
        String appendableChangelog = stripMargin(applyTemplate(append.getResolvedContentTemplate(context), props));

        Path target = context.getBasedir().resolve(append.getTarget());
        String fullChangelog = null;
        try {
            fullChangelog = Files.exists(target) ? new String(Files.readAllBytes(target), UTF_8) : "";
        } catch (IOException e) {
            fullChangelog = "";
            context.getLogger().trace(e);
            context.getLogger().warn(RB.$("ERROR_cannot_read_changelog"),
                context.relativizeToBasedir(target));
        }

        String separator = separator(releaser);

        if (fullChangelog.contains(JRELEASER_CHANGELOG_ANCHOR)) {
            fullChangelog = fullChangelog.replaceFirst(JRELEASER_CHANGELOG_ANCHOR,
                JRELEASER_CHANGELOG_ANCHOR + separator + appendableChangelog + separator + separator);
        } else {
            fullChangelog = appendableChangelog + separator + separator + fullChangelog;
        }

        context.getLogger().info(RB.$("changelog.generator.store"), context.getBasedir().relativize(target));

        try {
            Files.write(target, fullChangelog.getBytes(UTF_8), Files.exists(target) ? WRITE : CREATE_NEW);
        } catch (IOException e) {
            context.getLogger().trace(e);
            context.getLogger().error(RB.$("ERROR_unexpected_error_changelog_append"));
        }
    }

    private static String separator(BaseReleaser releaser) {
        String separator = lineSeparator();
        if (org.jreleaser.model.api.release.GitlabReleaser.TYPE.equals(releaser.getServiceName())) {
            separator += lineSeparator();
        }
        return separator;
    }
}