[Feedback wanted] Renaming collections not included in the Ansible community package

Project Discussions
, ,
1

Hello everyone,

We’d like to get your thoughts on a process of renaming collections published on Galaxy but not included in the Ansible community package.
The context: there are questions about it. After discussing, we could add some recommendations/process to docs.ansible.com.

  1. Should they rename the same repo and the stuff inside?
  2. Or should they fork the repo named with the new collection name already and rename stuff in that new repo? (i think this one is a way to go just to keep things separate, but maybe there are other justifications)

If we proceed with the new repo, the process could roughly look like the following:

1. After the stuff is moved, version 1.0.0 of the new one gets released (in this case all those version_addeds should be removed i think) published on Galaxy
2. They deprecate all modules in the old one by updating runtime.yaml as described in the module renaming guide
3.The old one’s README is updated to contain only a warning saying that the collection is deprecated and there’s a reference to the new repo.
4. Then they release the next major release of the old one that contains only the deprecations, the README update, and a changelog fragment announcing the deprecation
5. The old repo gets archived

Is my vision correct? I’d like to create a doc (i believe that would also help maintainers of collections included in the package to rename stuff smoothly).

Would appreciate any input, thanks!

2

Are you talking about a GitHub repo here?

1 Like
3

I think the choice between approaches 1 and 2 is a personal preference. In case of 1 I could create a branch for the old version before starting the rename (so you can later on create new releases of it).

On the steps:

  • Yes, version_added should be removed, since everything will be in the first release of the new collection.
  • For step 2 you still need the old repo / branch, and release process.
  • Step 3 makes sense also when the repo is renamed, because the README ends up on Galaxy.
  • Step 5 only makes sense if you forked the repo. (Probably obvious, just wanted to point it out :slight_smile: )
1 Like
4

@mariolenz yep
@felixfontein thanks for the feedback!