Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dead link in error message, for Galaxy contribution docs #396

Closed
sourcejedi opened this issue Jul 21, 2024 · 1 comment · Fixed by #397
Closed

Dead link in error message, for Galaxy contribution docs #396

sourcejedi opened this issue Jul 21, 2024 · 1 comment · Fixed by #397
Assignees
Labels
bug Something isn't working

Comments

@sourcejedi
Copy link

Summary

There are dead links, in the full message for "ERROR Computed fully qualified role name of does not follow current galaxy requirements".

Issue Type
  • Bug Report
OS / ENVIRONMENT
ansible-lint 24.7.1.dev7 using ansible-core:2.16.9 ansible-compat:24.7.0 ruamel-yaml:0.18.6 ruamel-yaml-clib:0.2.8
You are using a pre-release version of ansible-lint.
  • ansible installation method: OS package
  • ansible-lint installation method: source
STEPS TO REPRODUCE
mkdir test-role
cd test-role
mkdir meta
touch meta/main.yml
ansible-lint
Desired Behavior

Messages link to current documentation, which is somewhere in https://ansible.readthedocs.io/projects/galaxy-ng/en/latest/

Actual Behavior

Messages link to documentation pages which no longer exist, since galaxy.ansible.com switched to galaxy-ng.

ERROR    Computed fully qualified role name of t does not follow current galaxy requirements.
Please edit meta/main.yml and assure we can correctly determine full role name:

galaxy_info:
role_name: my_name  # if absent directory name hosting role is used instead
namespace: my_galaxy_namespace  # if absent, author is used instead

Namespace: https://galaxy.ansible.com/docs/contributing/namespaces.html#galaxy-namespace-limitations
Role: https://galaxy.ansible.com/docs/contributing/creating_role.html#role-names

As an alternative, you can add 'role-name' to either skip_list or warn_list.

Computed fully qualified role name of t does not follow current galaxy requirements.
Please edit meta/main.yml and assure we can correctly determine full role name:

galaxy_info:
role_name: my_name  # if absent directory name hosting role is used instead
namespace: my_galaxy_namespace  # if absent, author is used instead

Namespace: https://galaxy.ansible.com/docs/contributing/namespaces.html#galaxy-namespace-limitations
Role: https://galaxy.ansible.com/docs/contributing/creating_role.html#role-names

As an alternative, you can add 'role-name' to either skip_list or warn_list.

@sourcejedi sourcejedi added the bug Something isn't working label Jul 21, 2024
@cavcrosby
Copy link

I believe this issue should be filed in the ansible-compat repository as ansible-lint does have it as a dependency and when looking at https://github.com/ansible/ansible-compat/blob/main/src/ansible_compat/constants.py#L28, we can see this is where the message originates from.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants