[MCHANGES-468] custom template can not be loaded anymore

Open
#389 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
java
Domain
build-system

Research direction

Start with the changes:announcement-generate goal and compare the documented template paths with src/main/resources/org/apache/maven/plugins/changes/announcement/announcement.vm and src/main/resources/announcements/announcement.vm. Reproduce the missing-resource error using the shown template and templateDirectory configuration; done means the custom template loads and the documentation points to the correct default-template location.

Written by the indexing model from the issue text.

Description

bug priority:major

David Pilato opened MCHANGES-468 and commented

Hey team

I noticed few things about the mail generation when using a custom template.

First the default one moved from 

src/main/resources/org/apache/maven/plugin/announcement/announcement.vm

to

src/main/resources/org/apache/maven/plugins/changes/announcement/announcement.vm

But the documentation proposes to download the default one that is included in the plugin from https://github.com/apache/maven-changes-plugin/blob/master/src/main/resources/org/apache/maven/plugins/announcement/announcement.vm although the file moved to https://github.com/apache/maven-changes-plugin/blob/master/src/main/resources/org/apache/maven/plugins/changes/announcement/announcement.vm.

Then when trying to use my own template by either overloading the default one in my project:

src/main/resources/org/apache/maven/plugins/changes/announcement/announcement.vm

Or by setting the following configuration:

<template>announcement.vm</template>
<templateDirectory>announcements</templateDirectory>
 
And creating my template in:
 
src/main/resources/announcements/announcement.vm

As suggested by the documentation.

When running:

mvn changes:announcement-generate

I'm getting:

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-changes-plugin:3.0.0-M2:announcement-generate (default-cli) on project elasticsearch-beyonder: Resource not found.: Template not found. ( announcements/announcement.vm ): Unable to find resource 'announcements/announcement.vm' -> [Help 1]

Although my file does exist:

> ls -l src/main/resources/announcements/announcement.vm
{-}rw-r{-}{-}r{-}-@ 1 david staff 3535 Mar 6 19:28 src/main/resources/announcements/announcement.vm

 I'm running

Apache Maven 3.9.6 (bc0240f3c744dd6b6ec2920b3cd08dcc295161ae)
Maven home: /Users/david/.sdkman/candidates/maven/current
Java version: 21.0.2, vendor: Oracle Corporation, runtime: /Users/david/.sdkman/candidates/java/21.0.2-open
Default locale: fr_FR, platform encoding: UTF-8
OS name: "mac os x", version: "15.3.1", arch: "aarch64", family: "mac"


Affects: 3.0.0-M2

Dominant language
Java
Stars
15
Forks
22
Avg merge
1d 6h
Merged PRs (30d)
7

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/maven-changes-plugin

All issues in apache/maven-changes-plugin

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.