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

chore: replace master with main #7841

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

biru-codeastromer
Copy link
Contributor

Fixes #7126

Description:

This PR replaces all instances of master with main in the codebase, documentation, and GitHub workflows.

Changes include:

  • Updated Jenkinsfiles.
  • Updated documentation (README.adoc, CONTRIBUTING.adoc).
  • Updated GitHub workflows and configurations.

Please review and let me for further improvements !

@biru-codeastromer biru-codeastromer changed the title chore: replace master with main #7126 chore: replace master with main Feb 2, 2025
@biru-codeastromer
Copy link
Contributor Author

updated the branch .

@MarkEWaite
Copy link
Contributor

This seems like a lot of work with many, many opportunities for issues, without me being confident that @biru-codeastromer is ready for the weeks or months of issues that will result from the change.

Have you checked the other documentation generation locations that contribute to the jenkins.io site, like the backend extension indexer and the pipeline steps documentation generator? Have you investigated the changelog generator tooling to confirm that it will continue to submit pull requests that are targeting the correct branch?

@biru-codeastromer
Copy link
Contributor Author

biru-codeastromer commented Feb 4, 2025

This seems like a lot of work with many, many opportunities for issues, without me being confident that @biru-codeastromer is ready for the weeks or months of issues that will result from the change.

Have you checked the other documentation generation locations that contribute to the jenkins.io site, like the backend extension indexer and the pipeline steps documentation generator? Have you investigated the changelog generator tooling to confirm that it will continue to submit pull requests that are targeting the correct branch?

Hi Sir ,

Thanks for your constructive feedback! I completely understand that such a broad change comes with long-term implications, and I appreciate your insights and concerns.

Regarding your concerns:
-I haven’t yet checked the backend extension indexer and pipeline steps documentation generator. I will investigate these and provide an update.
-I’ll verify whether the changelog generator will still correctly submit PRs to the correct branch and ensure no unintended side effects.

I thought it would be better to raise a PR for improvements, so I prepared this as a draft to initiate discussions and track areas that need further research. Since there’s still work and investigation left, you can keep this PR in draft mode while I continue my research.

If you believe this is doable for me, I’d be happy to continue working on it.

Thanks again Sir for your valuable feedback! Much appreaciated

@zbynek
Copy link
Contributor

zbynek commented Feb 4, 2025

The list of files in #7126 also includes the issue templates, I think they should be included in the PR.

@biru-codeastromer
Copy link
Contributor Author

The list of files in #7126 also includes the issue templates, I think they should be included in the PR.

Thanks for the feedback ! Will be including them in the PR now .

@biru-codeastromer
Copy link
Contributor Author

The list of files in #7126 also includes the issue templates, I think they should be included in the PR.

I have added !

@biru-codeastromer
Copy link
Contributor Author

this file : "jenkins.io/updatecli/values.github-action.yaml" too has it as :

github:
  user: "GitHub Actions"
  email: "41898282+github-actions[bot]@users.noreply.github.com"
  username: "github-actions"
  token: "UPDATECLI_GITHUB_TOKEN"
  branch: "master"
  owner: "jenkins-infra"
  repository: "jenkins.io"

@kmartens27
Copy link
Contributor

Hi @biru-codeastromer, is this intended to just be the jenkins.io github repo documentation update, or would the jenkins.io documentation pages be updated in this PR as well? I ask because when reviewing the documentation on jenkins.io, there are several uses of the master URL that would be updated here.

If that will be a separate PR, please let me know and I'm happy to help gather all the usages and create a draft PR to make the accompanying updates.

@biru-codeastromer
Copy link
Contributor Author

biru-codeastromer commented Feb 6, 2025

Hi @kmartens27 Sir,

Thank you for your question and for offering to help! By observing the needs of the issue #7126 , This PR is currently focused on updating the GitHub repository documentation (e.g., README.adoc, CONTRIBUTING.adoc, Jenkinsfiles, and GitHub workflows) as part of the broader effort to migrate from master to main. It does not yet include updates to the Jenkins.io website documentation.

I agree that the Jenkins.io documentation pages also need to be updated to replace master with main. If you’re willing to help gather the usages and create a draft PR for those changes, that would be fantastic! I can then coordinate with you to ensure both PRs are aligned and cover all necessary updates.

Thanks

@dduportal
Copy link
Contributor

Hi @kmartens27 Sir,

Thank you for your question and for offering to help! By observing the needs of the issue #7126 , This PR is currently focused on updating the GitHub repository documentation (e.g., README.adoc, CONTRIBUTING.adoc, Jenkinsfiles, and GitHub workflows) as part of the broader effort to migrate from master to main. It does not yet include updates to the Jenkins.io website documentation.

I agree that the Jenkins.io documentation pages also need to be updated to replace master with main. If you’re willing to help gather the usages and create a draft PR for those changes, that would be fantastic! I can then coordinate with you to ensure both PRs are aligned and cover all necessary updates.

Thanks

As I advertised in an earlier issue @biru-codeastromer , this change is not an easy one. You cannot do it partially otherwise you'll break a LOT of things.
Hence the pointer by @kmartens27 : since your PR does change the branch reference on functional items such as GitHub workflow files and Jenkins pipelines, then it means you have to follow on any dependent element.

We should not do it on multiple PRs but only one and sync when the change is pushed : this is not a simple code change. We should do it once for all or not do it.

@biru-codeastromer
Copy link
Contributor Author

As I advertised in an earlier issue @biru-codeastromer , this change is not an easy one. You cannot do it partially otherwise you'll break a LOT of things. Hence the pointer by @kmartens27 : since your PR does change the branch reference on functional items such as GitHub workflow files and Jenkins pipelines, then it means you have to follow on any dependent element.

We should not do it on multiple PRs but only one and sync when the change is pushed : this is not a simple code change. We should do it once for all or not do it.

Hi Sir,
Thank you for the clarification! I now understand that this change needs to be done completely in a single PR to avoid breaking dependencies.

I’ll ensure that all necessary references—including functional items.

@biru-codeastromer
Copy link
Contributor Author

biru-codeastromer commented Feb 6, 2025

Hi @biru-codeastromer, is this intended to just be the jenkins.io github repo documentation update, or would the jenkins.io documentation pages be updated in this PR as well? I ask because when reviewing the documentation on jenkins.io, there are several uses of the master URL that would be updated here.

If that will be a separate PR, please let me know and I'm happy to help gather all the usages and create a draft PR to make the accompanying updates.

Hi @kmartens27 Sir,
Thanks for offering to help! Based on Damien Sir 's guidance, we need to complete all updates in this PR itself to avoid breaking things.

Since you mentioned finding several references to "master" in the Jenkins.io documentation, could you help gather them here so we can update everything in this PR?

Let me know how you'd like to collaborate on this ! or any help from my side if you need .

@dduportal
Copy link
Contributor

Hi @biru-codeastromer, is this intended to just be the jenkins.io github repo documentation update, or would the jenkins.io documentation pages be updated in this PR as well? I ask because when reviewing the documentation on jenkins.io, there are several uses of the master URL that would be updated here.
If that will be a separate PR, please let me know and I'm happy to help gather all the usages and create a draft PR to make the accompanying updates.

Hi @kmartens27 Sir, Thanks for offering to help! Based on Damien Sir 's guidance, we need to complete all updates in this PR itself to avoid breaking things.

Since you mentioned finding several references to "master" in the Jenkins.io documentation, could you help gather them here so we can update everything in this PR?

Let me know how you'd like to collaborate on this ! or any help from my side if you need .

A good technique for such kind of contribution requiring other contributor help (if they can) is to have "PR of your PR", e.g. doing PRs in your fork, with the branch update-branch-references as target (https://github.com/biru-codeastromer/jenkins.io/tree/update-branch-references) . When these PRs are merged, it creates commit(s) on the branch, which automatically updates the PR here. Each commit is co-authored by all contributors.

@biru-codeastromer
Copy link
Contributor Author

biru-codeastromer commented Feb 6, 2025

A good technique for such kind of contribution requiring other contributor help (if they can) is to have "PR of your PR", e.g. doing PRs in your fork, with the branch update-branch-references as target (https://github.com/biru-codeastromer/jenkins.io/tree/update-branch-references) . When these PRs are merged, it creates commit(s) on the branch, which automatically updates the PR here. Each commit is co-authored by all contributors.

Got it Sir ! That sounds like a great approach.

I'll check with @kmartens27 Sir to see if he would be willing to help with the Jenkins.io documentation updates directly in my forked repo (branch: https://github.com/biru-codeastromer/jenkins.io/tree/update-branch-references). If so, he can submit a PR there, and we can merge those changes into this PR to keep everything in sync.

Thanks for your suggestions!

@kmartens27
Copy link
Contributor

I'm happy to help @biru-codeastromer, I've already started the process of determining what content would need to be updated in my own fork, so once I have everything together, I can submit a pull to your fork so that everything can be combined.

@biru-codeastromer
Copy link
Contributor Author

I'm happy to help @biru-codeastromer, I've already started the process of determining what content would need to be updated in my own fork, so once I have everything together, I can submit a pull to your fork so that everything can be combined.

Thank you very much for your immense help Sir. Much appreciated and looking forward to it!

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

Successfully merging this pull request may close these issues.

Use main as primary branch
5 participants