# Alternative README paths should be supported

**URL:** <https://forum.ansible.com/t/alternative-readme-paths-should-be-supported/4056>\
**Category:** Get Help\
**Tags:** netbox, galaxy-ng\
**Created:** [February 26, 2024, 5:27am UTC](https://forum.ansible.com/t/alternative-readme-paths-should-be-supported/4056 "2024-02-26T05:27:07Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![lae](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/lae/32/2407_2.png) [@lae](https://forum.ansible.com/u/lae)\
**Post date:** [February 26, 2024, 5:27am UTC](https://forum.ansible.com/t/alternative-readme-paths-should-be-supported/4056/1 "2024-02-26T05:27:07Z")

</div>

I just tagged a new release for a legacy role of mine, went to import it on the new Galaxy website for the first time but was greeted with the following error:

```auto
===== LOADING ROLE ===== 
Importing with galaxy-importer 0.4.20 
Determined role name to be ansible-role-netbox 
 
Role loading failed! No role readme found 
 
Traceback (most recent call last): File "/app/galaxy_ng/app/api/v1/tasks.py", line 427, in legacy_role_import result = import_legacy_role(checkout_path, namespace.name, importer_config, logger) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/venv/lib64/python3.11/site-packages/galaxy_importer/legacy_role.py", line 51, in import_legacy_role return _import_legacy_role(dirname, namespace, cfg, logger) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/venv/lib64/python3.11/site-packages/galaxy_importer/legacy_role.py", line 57, in _import_legacy_role data = LegacyRoleLoader(dirname, namespace, cfg, logger).load() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/venv/lib64/python3.11/site-packages/galaxy_importer/loaders/legacy_role.py", line 43, in load self.readme = self._load_readme() ^^^^^^^^^^^^^^^^^^^ File "/venv/lib64/python3.11/site-packages/galaxy_importer/loaders/legacy_role.py", line 99, in _load_readme raise exc.ImporterError("No role readme found") galaxy_importer.exceptions.ImporterError: No role readme found  

Failed

```

Affected role: [Ansible Galaxy](https://galaxy.ansible.com/ui/standalone/roles/lae/netbox)

GitHub supports more README formats than just Markdown, and this role (as well as lae.proxmox) uses Asciidoc. I understand that Ansible Galaxy [does not plan to support Asciidoc](https://github.com/ansible/galaxy/issues/2010#issuecomment-532706537), but this should not be a reason to prevent role imports entirely. Is there a way to get around this that does not involve creating a `README.md` file?

(Some more information that’s probably relevant can be found at hxxps://forum.ansible.com/t/namespaces-and-remotes-are-messed-up-since-the-update/2195/5 (link count restriction))

---

<div class="post-metadata">

**Author:** ![lae](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/lae/32/2407_2.png) [@lae](https://forum.ansible.com/u/lae)\
**Post date:** [March 23, 2024, 2:44pm UTC](https://forum.ansible.com/t/alternative-readme-paths-should-be-supported/4056/2 "2024-03-23T14:44:41Z")

</div>

Am I supposed to be reporting this elsewhere?

---

<div class="post-metadata">

**Author:** ![felixfontein](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/felixfontein/32/7530_2.png) [@felixfontein](https://forum.ansible.com/u/felixfontein)\
**Post date:** [March 24, 2024, 9:39am UTC](https://forum.ansible.com/t/alternative-readme-paths-should-be-supported/4056/3 "2024-03-24T09:39:32Z")

</div>

If you want to publish your role on Ansible Galaxy or any other galaxy\_ng instance, you will have to provide a MarkDown version of your README.

Changing the importer to allow other formats basically means that Galaxy won’t be able to render basic role documentation anymore, which is something I don’t think anyone using Galaxy would like.

> [@lae](#):
>
> GitHub supports more README formats than just Markdown, and this role (as well as lae.proxmox) uses Asciidoc. I understand that Ansible Galaxy [does not plan to support Asciidoc](https://github.com/ansible/galaxy/issues/2010#issuecomment-532706537), but this should not be a reason to prevent role imports entirely. Is there a way to get around this that does not involve creating a `README.md` file?

If you want to use another format, you can either use a converter like pandoc to convert your README also to MarkDown, or you can add a small README.md file that links to the real README.

---

<div class="post-metadata">

**Author:** ![system](https://us1.discourse-cdn.com/ansible/original/1X/1882d9a01da5d8996a862359b0913cc568a39b84.svg) [@system](https://forum.ansible.com/u/system)\
**Post date:** [November 22, 2024, 6:46pm UTC](https://forum.ansible.com/t/alternative-readme-paths-should-be-supported/4056/4 "2024-11-22T18:46:30Z")

</div>

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.