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

switch default branch name to main in docs/ci #8210

Merged
merged 3 commits into from
Sep 23, 2024

Conversation

braingram
Copy link
Collaborator

@braingram braingram commented Jan 23, 2024

This PR updates the CI and docs to refer to a renamed "main" branch.

Unlike spacetelescope/stdatamodels#247 and spacetelescope/stpipe#136 it is likely that downstream packages are referring to the current default branch. For some period of time (I cannot find a statement that define for how long), github will redirect these requests to the renamed branch.

Known downstream uses will be listed here:

For developers, they will need to update their local clones and forks to match the new default branch.

Once the issue of updating packages that use the current jwst default branch is addressed, we should be able to:

  • coordinate renaming with all interested parties as mentioned by @nden
  • rename the default branch to "main"
  • merge this PR

It's possible codecov may need to be updated to use "main" (if it's not using the default branch).

The order of operations is:

Note that the items in the above checklist after merging this PR can be done in any order and aren't urgent as all will continue to work (with github redirecting requests directed to the old branch to the new branch).

Checklist for maintainers

  • added entry in CHANGES.rst within the relevant release section
  • updated or added relevant tests
  • updated relevant documentation
  • added relevant milestone
  • added relevant label(s)
  • ran regression tests, post a link to the Jenkins job below.
    How to run regression tests on a PR
  • Make sure the JIRA ticket is resolved properly

@github-actions github-actions bot added testing documentation automation Continuous Integration (CI) and testing automation tools labels Jan 23, 2024
@braingram braingram requested a review from nden January 23, 2024 16:38
@braingram braingram force-pushed the rename_to_main branch 2 times, most recently from e0d4e7a to 7c0ae42 Compare February 15, 2024 18:33
@braingram braingram force-pushed the rename_to_main branch 2 times, most recently from 1bd9d60 to 4cf10e4 Compare April 1, 2024 12:48
@braingram braingram marked this pull request as ready for review April 1, 2024 12:48
@braingram braingram requested a review from a team as a code owner April 1, 2024 12:48
@braingram braingram requested a review from hbushouse May 14, 2024 19:25
Copy link
Collaborator

@emolter emolter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally LGTM. Changelog needs to be rebased. The only other place where I see instances that might need to be changed to "main" is in the Jenkinsfiles - can you check those, or is there a reason they don't need updating?

@braingram
Copy link
Collaborator Author

Generally LGTM. Changelog needs to be rebased. The only other place where I see instances that might need to be changed to "main" is in the Jenkinsfiles - can you check those, or is there a reason they don't need updating?

Thanks and good question. Thanks for finding those references to the branch name. I updated them in this PR. @jhunkeler are there other jenkins/bytesalad (or other systems) that will need to be updated for a new default branch name?

@jhunkeler
Copy link
Collaborator

On the Jenkins side we'd need to change the branch from master to main for each pipeline. Feel free to ping me whenever you want to change this.

@braingram
Copy link
Collaborator Author

Rebasing and leaving off a changelog until #8671 can be merged

Copy link
Collaborator

@melanieclarke melanieclarke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs changes look good to me. It will be nice to get this settled!

What is the status on all the various coordination needed?

@braingram
Copy link
Collaborator Author

Docs changes look good to me. It will be nice to get this settled!

What is the status on all the various coordination needed?

Thanks. I think we're all set since github will redirect requests to master to main.

@tapastro
Copy link
Contributor

I'm happy to get this merged today. If we do so, we'll need to update the Jenkins instances to point to main afterwards, correct @jhunkeler ? Any other blockers remaining pre/post merge?

@melanieclarke
Copy link
Collaborator

Do the GA regression tests need updating too?

@braingram
Copy link
Collaborator Author

Do the GA regression tests need updating too?

After the branch rename the one reference to 'master' here can be updated:
https://github.com/spacetelescope/RegressionTests/blob/02913aebf6edff5c2435408ba7837cf86ad47b6f/.github/workflows/jwst.yml#L113

I'll update the list in the description with checkboxes.

@braingram
Copy link
Collaborator Author

FWIW I do not have permissions to rename the branch (the required first step prior to merging this PR). @tapastro @melanieclarke do either of you have permissions? If not @jhunkeler may.

@hbushouse hbushouse removed their request for review September 23, 2024 17:08
@melanieclarke
Copy link
Collaborator

FWIW I do not have permissions to rename the branch (the required first step prior to merging this PR). @tapastro @melanieclarke do either of you have permissions? If not @jhunkeler may.

It looks like we probably can - jwst-pipeline-maintainers have the admin role - but I'm a little uncomfortable touching the GitHub branches myself. Joe also has admin role, and Zach too.

@braingram
Copy link
Collaborator Author

It looks like we probably can - jwst-pipeline-maintainers have the admin role - but I'm a little uncomfortable touching the GitHub branches myself. Joe also has admin role, and Zach too.

Thanks for checking. Any objection to going forward with the branch rename? One option could be to:

  • approve this PR
  • have either @jhunkeler or @zacharyburnett rename the default branch to "main"
  • merge this PR
  • follow the rest of the checklist in the description

Copy link
Collaborator

@melanieclarke melanieclarke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay by me to move forward as @braingram suggests.

@zacharyburnett
Copy link
Collaborator

alright, I'll go ahead and rename the master branch to main

@zacharyburnett
Copy link
Collaborator

done!

@braingram
Copy link
Collaborator Author

Thanks @zacharyburnett Would you also force merge this PR?

@zacharyburnett zacharyburnett merged commit b8cb307 into spacetelescope:main Sep 23, 2024
10 checks passed
@zacharyburnett
Copy link
Collaborator

Thanks @zacharyburnett Would you also force merge this PR?

UNLIMITED POWER!!!

@braingram braingram deleted the rename_to_main branch September 23, 2024 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation Continuous Integration (CI) and testing automation tools documentation regression_testing testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants