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

Autoclosing issue in package-template closes issue in affiliated package #81

Closed
bsipocz opened this issue Jun 11, 2014 · 7 comments
Closed
Labels
docs won't fix: deprecated Template is deprecated here

Comments

@bsipocz
Copy link
Member

bsipocz commented Jun 11, 2014

It seems like using the "autofix / close issue" feature in package-template closes the matching issues in packages where the template was used. I'm not sure this is considered to be a bug or just an antifeature of github.

Example:
astropy/photutils#69 (comment)

@bsipocz bsipocz changed the title Autoclosing issue closes issue in affiliated packages Autoclosing issue in package-template closes issue in affiliated packages Jun 11, 2014
@bsipocz bsipocz changed the title Autoclosing issue in package-template closes issue in affiliated packages Autoclosing issue in package-template closes issue in affiliated package Jun 11, 2014
@astrofrog
Copy link
Member

Woah, ok. That's... dangerous. Guess we need to not use this functionality in the package-template commit log?

cc @mdboom @embray @eteq

@eteq
Copy link
Member

eteq commented Jun 12, 2014

Whoa, yeah, that's bizzare and clearly we have to be cautious here. I'm going to ask github support about this and I'll post here if they have any suggestions.

@mdboom
Copy link
Contributor

mdboom commented Jun 12, 2014

Ouch. They must have some way to avoid this when a repository is explicitly created as a fork of another one, since this doesn't happen (I don't think) to mdboom/astropy when astropy/astropy autocloses a bug. The difference with affiliated packages is that they are not explicit forks (github doesn't have metadata about that), they just pull in commits from package-template. That's a good one, and I don't even see an obvious way that github could avoid doing what it's doing. If we still want to use this feature it might work to say explicitly: Fixes astropy/package-template#X rather than just #X.

@eteq
Copy link
Member

eteq commented Jun 16, 2014

@bsipocz @astrofrog @mdboom @embray - github support's advice was pretty much just "You might like to use the "Fixes User/Repository#Num" format instead, which should only close the issue in the repository specified, regardless of where your commit appears". So I think we'd better make sure we stick with astropy/package-template### from now on.

@astrofrog
Copy link
Member

Ok, sounds good! Not sure where we should document this...

@astrofrog astrofrog added this to the Future milestone Jul 22, 2014
@astrofrog astrofrog added the docs label Jul 22, 2014
@pllim pllim pinned this issue Jan 31, 2020
@bsipocz
Copy link
Member Author

bsipocz commented Feb 4, 2020

Another similar issue is that package template tags are being inherited in packages and are soo damn difficult to clean up years after the fact (e.g. we have 1.0 etc in astroquery, that are coming back each time I fetch from someone else's fork).

For the issues, we can indeed deal with it with using the astropy/package-template###, as suggested above. Also, I believe it becomes less of an issue since we switched to cookiecutter rather than suggesting to bring the repo history.

So overall, I suggest to close this, as there isn't much we can do here (we could rewrite the commit messages and force push, a tiny bit drastic, but that's the only thing we could do about the past).

@pllim
Copy link
Member

pllim commented Aug 11, 2023

This issue will still be pinned even after close.

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

No branches or pull requests

5 participants