antsibull-docs icon indicating copy to clipboard operation
antsibull-docs copied to clipboard

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

Open felixfontein opened this issue 2 years ago • 2 comments

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

felixfontein avatar Jan 11 '23 19:01 felixfontein

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.

mariolenz avatar Jan 11 '23 20:01 mariolenz

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 avatar Jan 11 '23 20:01 felixfontein

I created https://github.com/ansible-community/ansible-build-data/pull/450 as a way how the format could look like in collection-meta.yml.

felixfontein avatar Aug 26 '24 18:08 felixfontein

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.

felixfontein avatar Aug 26 '24 19:08 felixfontein

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

gotmax23 avatar Sep 03 '24 16:09 gotmax23

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 https://github.com/ansible-community/antsibull/pull/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).

felixfontein avatar Sep 03 '24 19:09 felixfontein

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

gotmax23 avatar Sep 07 '24 18:09 gotmax23

Ref: https://github.com/ansible-community/antsibull-core/pull/168 Ref: https://github.com/ansible-community/antsibull/pull/620

felixfontein avatar Sep 10 '24 20:09 felixfontein

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.

felixfontein avatar Sep 12 '24 22:09 felixfontein