Skip to content
This repository has been archived by the owner on Aug 11, 2023. It is now read-only.

release tags could be inherited by downstream packages using the template #512

Closed
bsipocz opened this issue May 4, 2021 · 10 comments
Closed
Labels
bug won't fix: deprecated Template is deprecated here

Comments

@bsipocz
Copy link
Member

bsipocz commented May 4, 2021

Packages that use the template with the history may inherited release tags corresponding to the package template. With cookiecutter this may not be an issue any more as no commit details, metadata, credits, etc are inherited, nevertheless there could be many tags inherited that package authors may want to cleanup.

(See e.g. astroquery. I've cleaned up the main repo, but the errenous tags of e.g. v0.4.1, v1.0, v1.1, etc are still around in people's forks who forked after those changes from the template were applied to the repo).

Action item: document this, maybe batchissue it to affected users

@bsipocz bsipocz added the bug label May 4, 2021
@astrofrog
Copy link
Member

astrofrog commented May 5, 2021

If we wanted to fix this we could automatically go through repos that include an _astropy_init.py file, check the tag dates against the template and open an issue listing the tags that can be deleted safely and how to do it? Or we could just document it 😀

@bsipocz
Copy link
Member Author

bsipocz commented May 5, 2021

Yes, that's what I meant with 'batchissuing'. Which may be a bit over the board given a proper cleanup is difficult as those tags may come back from forks, too (same that happened in astropy with those really old tags)

@pllim
Copy link
Member

pllim commented May 5, 2021

Hmm. I never noticed that on my packages. Maybe I wasn't templating properly... 😆 Let's pin this.

@pllim pllim pinned this issue May 5, 2021
@pllim
Copy link
Member

pllim commented May 5, 2021

p.s. While _astropy_init.py is a good indicator, it might still miss some. There is no guarantee that people would not have deleted it afterwards for one reason or another. I guess we can't catch them all.

@pllim
Copy link
Member

pllim commented May 14, 2021

So, if a repo accidentally inherited the tags from this template, will their tags match exactly (or is subset of) the list in https://github.com/astropy/package-template/releases ?

@bsipocz
Copy link
Member Author

bsipocz commented May 14, 2021

yes, the tags will be matched (https://github.com/astropy/package-template/tags). So date, or committer, or commit message could be used to double-check.

@pllim
Copy link
Member

pllim commented May 14, 2021

As far as my Github-fu allows, I found 346 repos with _astropy_init.py and only 8 of them are affected. I have opened issues that are linked to this issue here. But this does not prevent future occurences.

@bsipocz
Copy link
Member Author

bsipocz commented May 14, 2021

Yeah, we don't really support bringing the whole commit history anymore, so they would not see the tags.

@pllim
Copy link
Member

pllim commented May 17, 2021

@bsipocz , should we close this as resolved then? Not sure what else we can do here.

@pllim
Copy link
Member

pllim commented Aug 11, 2023

@pllim pllim closed this as not planned Won't fix, can't repro, duplicate, stale Aug 11, 2023
@pllim pllim added the won't fix: deprecated Template is deprecated here label Aug 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug won't fix: deprecated Template is deprecated here
Projects
None yet
Development

No branches or pull requests

3 participants