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

Future of default branch naming #64

Open
pllim opened this issue Mar 9, 2021 · 7 comments
Open

Future of default branch naming #64

pllim opened this issue Mar 9, 2021 · 7 comments

Comments

@pllim
Copy link

pllim commented Mar 9, 2021

Do you have plans to rename the default branch here? I see that it is hardcoded in https://github.com/astropy/astropy/blob/0a29184ea1d5fdc2876e9dd3294c56e32287e0a5/azure-pipelines.yml#L11 . So if you change it, please open PR downstream. Thanks!

@ConorMacBride
Copy link
Member

Would Azure Pipelines follow GitHub's redirect to the new default branch name, or would jobs fail for all downstream projects still using the old default name as a ref?

@Cadair
Copy link
Member

Cadair commented May 6, 2021

I don't think it would, so I have no intention to change the default branch here as it would require patching every downstream project.

The only thing I can think of would be to maintain a "master" branch on this repo which is automatically synced with the default branch, so that not updated repositories would continue to work. If someone wanted to do this then I would be willing to test it out.

@Cadair
Copy link
Member

Cadair commented Nov 11, 2021

I am going to close this as wont-fix due to the compatibility issues it would cause.

@Cadair Cadair closed this as completed Nov 11, 2021
@ConorMacBride
Copy link
Member

ConorMacBride commented Nov 11, 2021

The Azure docs says it'll use the default branch if a ref isn't specified so we could probably remove the recommendation in the docs to specify a ref.

I'd be happy to look into the separate branch option. Instead of syncing, it should be possible to create templates in a "master" branch that call the templates in a default "main" branch we could just copy the current tox and publish templates to a new "master" branch and append a job to them to show a deprecation warning in the azure gui saying that people need to remove the ref or update it to "main" to receive updates.

@Cadair Cadair reopened this Nov 23, 2021
@Cadair
Copy link
Member

Cadair commented Nov 23, 2021

The Azure docs says it'll use the default branch if a ref isn't specified so we could probably remove the recommendation in the docs to specify a ref.

👍 Seems sensible.

show a deprecation warning in the azure gui saying that people need to remove the ref or update it to "main" to receive updates

This concerns me a little, because I am not sure if people would see them. I wonder if we could generate something a little more visible.

@Cadair
Copy link
Member

Cadair commented Nov 23, 2021

If we were to do this, we should really use some of the astropy batch PR/issue scripts to try and fix / warn all the 60 repos using these templates.

@pllim
Copy link
Author

pllim commented Nov 23, 2021

Re: batch PR -- Theoretically possible but if you want to do due diligence, someone still needs to vet the PR diffs after they are open.

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

No branches or pull requests

3 participants