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.

Sign up for GitHub

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

Jump to bottom

plugin entries in seealso don't work in role argspecs #237

Closed
briantist opened this issue Jan 26, 2024 · 3 comments · Fixed by #241
Closed

plugin entries in seealso don't work in role argspecs #237

briantist opened this issue Jan 26, 2024 · 3 comments · Fixed by #241

Comments

@briantist
Copy link
Contributor

https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#documentation-fields

# Reference by plugin name
- plugin: ansible.builtin.file
  plugin_type: lookup

# Reference by plugin name, including description
- plugin: ansible.builtin.file
  plugin_type: lookup
  description: You can use the ansible.builtin.file lookup to read files on the control node.

In role argspecs, they are treated as invalid:

12 validation errors for RoleSchema
[2024-01-25T19:19:07.788Z]     entry_points -> main -> seealso -> 0 -> module
[2024-01-25T19:19:07.788Z]       field required (type=value_error.missing)
[2024-01-25T19:19:07.788Z]     entry_points -> main -> seealso -> 0 -> plugin
[2024-01-25T19:19:07.788Z]       extra fields not permitted (type=value_error.extra)
[2024-01-25T19:19:07.788Z]     entry_points -> main -> seealso -> 0 -> plugin_type
[2024-01-25T19:19:07.788Z]       extra fields not permitted (type=value_error.extra)
[2024-01-25T19:19:07.788Z]     entry_points -> main -> seealso -> 0 -> description
[2024-01-25T19:19:07.788Z]       field required (type=value_error.missing)
[2024-01-25T19:19:07.788Z]     entry_points -> main -> seealso -> 0 -> ref
[2024-01-25T19:19:07.788Z]       field required (type=value_error.missing)
[2024-01-25T19:19:07.788Z]     entry_points -> main -> seealso -> 0 -> plugin
[2024-01-25T19:19:07.788Z]       extra fields not permitted (type=value_error.extra)
[2024-01-25T19:19:07.788Z]     entry_points -> main -> seealso -> 0 -> plugin_type
[2024-01-25T19:19:07.788Z]       extra fields not permitted (type=value_error.extra)
[2024-01-25T19:19:07.788Z]     entry_points -> main -> seealso -> 0 -> description
[2024-01-25T19:19:07.788Z]       field required (type=value_error.missing)
[2024-01-25T19:19:07.788Z]     entry_points -> main -> seealso -> 0 -> link
[2024-01-25T19:19:07.788Z]       field required (type=value_error.missing)
[2024-01-25T19:19:07.788Z]     entry_points -> main -> seealso -> 0 -> name
[2024-01-25T19:19:07.788Z]       field required (type=value_error.missing)
[2024-01-25T19:19:07.788Z]     entry_points -> main -> seealso -> 0 -> plugin
[2024-01-25T19:19:07.788Z]       extra fields not permitted (type=value_error.extra)
[2024-01-25T19:19:07.788Z]     entry_points -> main -> seealso -> 0 -> plugin_type

@felixfontein has already found the problem:
https://github.com/ansible-community/antsibull-docs/blob/main/src/antsibull_docs/schemas/docs/base.py#L613
https://github.com/ansible-community/antsibull-docs/blob/main/src/antsibull_docs/schemas/docs/role.py#L63
@felixfontein felixfontein mentioned this issue Jan 26, 2024
Merged
@felixfontein
Copy link
Collaborator

#241 fixes this.

@felixfontein
Copy link
Collaborator

Please note that we probably want to delay a new release until antsibull-core 3.0.0 is out. @gotmax23 how long do you think that will take? My guess is that it's mostly ready, but I'm not sure whether I'm missing something...

Ref: ansible-community/antsibull-core#125

@briantist
Copy link
Contributor Author

briantist commented Jan 26, 2024 •
edited
Loading

thanks for your work on this, shame it'll have to wait to be released but that's not the worst thing, looking forward to it!

jooola referenced this issue in ansible-collections/hetzner.hcloud Feb 1, 2024
@renovate
deps: update dependency antsibull-docs to >=2.7,<2.8 (#446)
2ebaa35 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[antsibull-docs](https://togithub.com/ansible-community/antsibull-docs)
| `>=2.6,<2.7` -> `>=2.7,<2.8` |
[![age](https://developer.mend.io/api/mc/badges/age/pypi/antsibull-docs/2.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/antsibull-docs/2.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/antsibull-docs/2.6.1/2.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/antsibull-docs/2.6.1/2.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>ansible-community/antsibull-docs (antsibull-docs)</summary>

###
[`v2.7.0`](https://togithub.com/ansible-community/antsibull-docs/blob/HEAD/CHANGELOG.rst#v270)

[Compare
Source](https://togithub.com/ansible-community/antsibull-docs/compare/2.6.1...2.7.0)

\======

## Release Summary

Bugfix and refactoring release.

## Minor Changes

- Explicitly set up Galaxy context instead of relying on deprecated
functionality
([https://github.com/ansible-community/antsibull-docs/pull/234](https://togithub.com/ansible-community/antsibull-docs/pull/234)).

## Bugfixes

- Fix schema for `seealso` in role entrypoints. Plugin references now
work
([https://github.com/ansible-community/antsibull-docs/issues/237](https://togithub.com/ansible-community/antsibull-docs/issues/237),
[https://github.com/ansible-community/antsibull-docs/pull/240](https://togithub.com/ansible-community/antsibull-docs/pull/240)).
- Make error reporting for invalid references in `plugin` `seealso`
entries more precise
([https://github.com/ansible-community/antsibull-docs/pull/240](https://togithub.com/ansible-community/antsibull-docs/pull/240)).
- Support new `ansible-doc --json` output field `plugin_name`
([https://github.com/ansible-community/antsibull-docs/pull/242](https://togithub.com/ansible-community/antsibull-docs/pull/242)).
- Use certain fields from library context instead of app context that
are deprecated in the app context and will be removed from
antsibull-core 3.0.0
([https://github.com/ansible-community/antsibull-docs/pull/233](https://togithub.com/ansible-community/antsibull-docs/pull/233)).

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/ansible-collections/hetzner.hcloud).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xNTMuMiIsInVwZGF0ZWRJblZlciI6IjM3LjE1My4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix role seealsos of type plugin felixfontein/antsibull-docs
2 participants
@briantist @felixfontein