Skip to content

Conversation

circlecube
Copy link
Member

Proposed changes

In brand plugins, we do work on develop and only merge to main at release time, more a traditional git-flow approach than with modules. I think ideally we can target develop instead of main in this case for the i18n workflow. Open to thoughts, though.

Type of Change

Production

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Dependency update
  • Refactoring / housekeeping (changes to files not directly related to functionality)

Development

  • Tests
  • Dependency update
  • Environment update / refactoring
  • Documentation Update

Visual

Checklist

  • I have read the CONTRIBUTING doc
  • I have viewed my change in a web-browser
  • Linting and tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

@circlecube circlecube requested review from desrosj and wpscholar August 7, 2025 15:40
@circlecube circlecube self-assigned this Aug 7, 2025
Copy link
Member

@desrosj desrosj left a comment

Choose a reason for hiding this comment

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

The actual code change in this PR looks great. 👍

I do have a few points that should be considered to ensure more consistency.

I'm fine with whatever Git flow works for the teams. Since I am not regularly involved with these repositories, I don't have any strong opinions. But I do think that we should enforce it for all plugin repos at the same time (and all module repos at the same time if we also want to follow that flow with those) and confirm that workflows and Dependabot configurations all expect develop to be the BASE branch for changes.

The primary branch for this repo is currently set to main. This has a few consequences:

  • all new pull requests default to using main as the base branch
  • the default branch checked out when running git clone is main, which can easily result in someone building out a PR without the latest changes on accident.
  • All workflows that run on schedule will only ever run in main and not develop

The last one has implications for workflows that run regularly, such as any workflows that aim to test the code base at an interval. It will only ever test the most recent release that was published.

Dependabot is currently configured to open pull requests for dependency updates with a BASE branch of develop. This means that until main is updated in preparation for the next release, these schedule events will have the potential to be utilizing outdated dependencies that have since been updated in develop. This is mainly important for any updates applied to workflow files that are applied that prevent disruptions as a result of service-level changes. While the brand plugins receive regular updates at this point in time, that may not always be the case, and may not be the case for other repositories that we extend this practice to (modules, workers, etc.).

Unless there are reasons that are not immediately apparent as to why develop should not be made the primary branch, I think we should also change the primary branch to make it easier to follow this flow, and make our scheduled testing workflows more

@circlecube
Copy link
Member Author

This makes sense to me. I can't think of any big reasons why we couldn't change the default branch to develop to address these issues. It is the branch we are working off of by default. The main branch would continue to represent production code only, and we update it with each release.

@wpscholar what do you think? @earnjam?

@circlecube
Copy link
Member Author

I'll go ahead and merge this, but we should continue the discussion about the default branch and its impact on our workflows. @wpscholar is currently reimagining the release workflow and our dev workflow, and those points should be considered. But that discussion doesn't need to be a blocker to this PR.

@circlecube circlecube merged commit b17f350 into main Aug 13, 2025
31 checks passed
@circlecube circlecube deleted the update/i18n-target-branch branch August 13, 2025 15:17
@circlecube circlecube added this to the August 20, 2025 Release milestone Aug 13, 2025
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

Successfully merging this pull request may close these issues.

2 participants