k-krawczyk opened a new pull request, #25409:
URL: https://github.com/apache/camel/pull/25409

   ## Summary
   
   Applies the same treatment as CAMEL-23702 (#24063), but to the Maven 
archetypes instead of the JBang export.
   
   - Renames `ReadMe.txt` to `README.md` in all six archetypes and rewrites the 
content in Markdown, with the documentation links refreshed to `https` and to 
the current `camel.apache.org/manual/writing-components.html` location.
   - Adds an `AGENTS.md` to every generated project: the Apache Camel LLM index 
(https://camel.apache.org/llms.txt), the `.html` -> `.md` documentation trick, 
a pointer to the Camel CLI and the Camel MCP server with an explicit "do not 
invent component URIs or options" instruction, plus the project layout, the 
build/run commands and the conventions of that archetype.
   - Updates the six `archetype-metadata.xml` file sets accordingly — the 
readme is listed explicitly there, so the rename alone would have silently 
dropped it.
   - Adds a `camel-archetypes` entry to the 4.22 upgrade guide.
   
   ## Drive-by fix
   
   `camel-archetype-api-component` declared its readme in the 
`__artifactId__-component/` file set while the file actually lives at the 
project root, so **no readme was generated at all**. Reproduced against the 
released archetype:
   
   ```
   mvn archetype:generate -DarchetypeGroupId=org.apache.camel.archetypes \
     -DarchetypeArtifactId=camel-archetype-api-component 
-DarchetypeVersion=4.21.0 ...
   ```
   
   produces a project with `pom.xml` and the two modules, and no readme. This 
PR moves the entry to a root file set, so the readme is generated again.
   
   ## Notes
   
   The `.md` file sets are deliberately left unfiltered, as `ReadMe.txt` was. 
Markdown headings start with `#`, which is the Velocity directive prefix, so 
the generated docs are kept free of interpolation rather than risking mangled 
output. Consequently the content uses no `${artifactId}`-style placeholders.
   
   ## Verification
   
   - `./mvnw install -Dquickly -f archetypes/pom.xml` — BUILD SUCCESS.
   - `mvn archetype:generate` run for all six archetypes against the locally 
installed `4.22.0-SNAPSHOT`: `README.md` and `AGENTS.md` are generated at the 
root of every project, with no unresolved `${...}` or `__x__` tokens.
   - The generated content was checked against the actual generated trees 
(`MainApp` / `MyRouteBuilder`, `MyApplication` / `MyBean` / `MyConfiguration`, 
`camel-context.xml`, `META-INF/services/.../<scheme>`, the `DataFormat` 
implementation), so it does not describe files that are not there.
   - `apache-rat-plugin:check` on the archetypes module: 0 unapproved 
(`**/*.md` is excluded in the root POM).
   - All referenced URLs return HTTP 200, including the `.md` variant of the 
manual page.
   
   The archetype integration tests under `src/test/resources/projects-disabled` 
are disabled, so verification was done by generating projects manually as 
described above.
   
   _Reported by Claude Code on behalf of Karol Krawczyk_
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to