apache / apache/maven-changes-plugin

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

Open
#389 1 comment 0 reactions 0 assignees View on GitHub
bug priority:major
Dominant language
Java
Stars
15
Forks
22
Avg merge
8h 1m
Merged PRs (30d)
3

Description

**[David Pilato](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=dadoonet)** opened **[MCHANGES-468](https://issues.apache.org/jira/browse/MCHANGES-468?redirect=false)** 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](https://maven.apache.org/plugins/maven-changes-plugin/examples/using-a-custom-announcement-template.html) 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.](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:

`announcement.vm`
`announcements`
 
And creating my template in:
 
`src/main/resources/announcements/announcement.vm`

As suggested by [the documentation](https://maven.apache.org/plugins/maven-changes-plugin/examples/using-a-custom-announcement-template.html).

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

Contributor guide

No contributing guide indexed for this repository

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.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.