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

Allow to declare collections as unmaintained, ... for Ansible docsite builds #93

Closed
felixfontein opened this issue Jan 11, 2023 · 9 comments · Fixed by #330
Closed

Allow to declare collections as unmaintained, ... for Ansible docsite builds #93

felixfontein opened this issue Jan 11, 2023 · 9 comments · Fixed by #330
Labels
enhancement New feature or request

Comments

@felixfontein
Copy link
Collaborator

That should use https://github.com/ansible-community/ansible-build-data/blob/main/8/collection-meta.yaml somehow.

@felixfontein felixfontein added the enhancement New feature or request label Jan 11, 2023
@mariolenz
Copy link

I'm not sure if this is really doable, but if we consider a collection unmaintained we will remove it from the Ansible community package. Maybe we could generate the changelog entry automatically from collection-meta.yml so we don't have to define a collection as unmaintained in two places?

Just an idea.

@felixfontein
Copy link
Collaborator Author

This is mainly for the time between when we decide to remove it and when it's actually removed. In that time, showing our intention on the docsite is a good idea IMO.

@felixfontein
Copy link
Collaborator Author

I created ansible-community/ansible-build-data#450 as a way how the format could look like in collection-meta.yml.

@felixfontein
Copy link
Collaborator Author

Automatically generated changelog entries would be possible as well (I just pushed a commit that has more information needed for it), but there are more special cases, for example Since they've also announced to not support ansible-core 2.18, it will be removed from Ansible 11 if no one starts maintaining it again before Ansible 11 for frr.frr and openvswitch.openvswitch.

@gotmax23
Copy link
Collaborator

gotmax23 commented Sep 3, 2024

If the goal is for antsibull-docs to read the collection-meta.yml, then is antsibull the right place for its pydantic model?

@felixfontein
Copy link
Collaborator Author

Both antsibull and antsibull-docs should read / process it. I guess it makes more sense to move it to antsibull-core then.

I'd prefer to first merge ansible-community/antsibull-build#617 with the schema in antsibull itself though, and then create a PR to move the schema to antsibull-core. Does that sound acceptable? That's easier than coordinating two PRs in both repos (espectially w.r.t. CI).

@gotmax23
Copy link
Collaborator

gotmax23 commented Sep 7, 2024

You wrote the code so whatever way you prefer to land it is fine with me :). I left some feedback on the antsibull PR.

@felixfontein
Copy link
Collaborator Author

@felixfontein
Copy link
Collaborator Author

I've implemented this in #330. That PR shows deprecation markers in collection lists and deprecation notes on plugin/role pages and the collection index pages of collections that will be removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants