I wish to present a README file on CodeArtifact. I deployed a new version that contains a README.MD
file however the Description (marked in red) is greyed out.
Found this AWS documentation however I did not understand what I should do to present my README.MD
file.
- I can view the README at Bitbucket and inside the Intellij.
- Java code.
- Maven project management.
Following @Ermiya Eskandary comment, I made two README files, one in the root and a second in root of the module. After redeploying, the description is still not showing.
Project structure:
The POM file of the relevant module:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>---</artifactId>
<groupId>---</groupId>
<version>1.0.2</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>---</artifactId>
<version>1.0.14</version>
<dependencies>
<dependency>
<groupId>---</groupId>
<artifactId>---</artifactId>
<version>1.0.2</version>
</dependency>
</dependencies>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
</project>
Unfortunately CodeArtifact does not currently support displaying Readme files for Maven packages. The GetPackageVersionReadme API will return "not found" for all Maven packages.