starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Replace master branch with a release branch #8412

New Issue
Closed
opened 2025-12-29 20:36:22 +01:00 by adam · 4 comments
adam commented 2025-12-29 20:36:22 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Aug 3, 2023).

Originally assigned to: @jeremystretch on GitHub.

Proposed Changes

We currently maintain three persistent branches within the project:

  • master - Contains the latest stable release
  • develop - Any work intended for the next patch release
  • feature - Feature work & breaking changes intended for the next minor release (e.g. v3.6)

The master branch is essentially a clone of develop, which gets merged every time a new release is to be published. We can remove this branch and create a new release branch which contains only a single squashed commit for each release.

Justification

Our current approach can be confusing as many newcomers expect master to function as the repo's default branch (ours is develop). And introducing a new release branch which is limited to only squashed commits provides a much more efficient mechanism for checking out the latest stable release using git (e.g. git checkout release).

Originally created by @jeremystretch on GitHub (Aug 3, 2023). Originally assigned to: @jeremystretch on GitHub. ### Proposed Changes We currently maintain three persistent branches within the project: - `master` - Contains the latest stable release - `develop` - Any work intended for the next patch release - `feature` - Feature work & breaking changes intended for the next minor release (e.g. v3.6) The `master` branch is essentially a clone of `develop`, which gets merged every time a new release is to be published. We can remove this branch and create a new `release` branch which contains only a single squashed commit for each release. ### Justification Our current approach can be confusing as many newcomers expect `master` to function as the repo's default branch (ours is `develop`). And introducing a new `release` branch which is limited to only squashed commits provides a much more efficient mechanism for checking out the latest stable release using git (e.g. `git checkout release`).
adam added the status: acceptedtype: housekeepingnetbox labels 2025-12-29 20:36:22 +01:00
adam closed this issue 2025-12-29 20:36:23 +01:00
adam commented 2025-12-29 20:36:23 +01:00
Author
Owner
Copy Link

@pv2b commented on GitHub (Aug 18, 2023):

For my two cents: Removing or renaming the "master" branch makes sense. The "master" branch not being the one being actively developed was confusing for me as a newcomer as well.

That said, I'm not sure how much value there is to squashing the commits on the "release" branch. Is the efficiency really worth not being able to "git blame" if you have the release branch checked out? Personally, I'd say no, I'd much rather have git blame work if I'm checked out with the release branch rather than have my checkout take half a second instead of three.

@pv2b commented on GitHub (Aug 18, 2023): For my two cents: Removing or renaming the "master" branch makes sense. The "master" branch not being the one being actively developed was confusing for me as a newcomer as well. That said, I'm not sure how much value there is to squashing the commits on the "release" branch. Is the efficiency really worth not being able to "git blame" if you have the release branch checked out? Personally, I'd say no, I'd much rather have git blame work if I'm checked out with the release branch rather than have my checkout take half a second instead of three.
adam commented 2025-12-29 20:36:23 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Feb 3, 2024):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Feb 3, 2024): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 20:36:24 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Aug 2, 2024):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Aug 2, 2024): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 20:36:24 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jan 6, 2025):

We've opted to designate the new default branch as main per convention.

@jeremystretch commented on GitHub (Jan 6, 2025): We've opted to designate the new default branch as `main` per convention.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label netbox status: accepted type: housekeeping
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#8412
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?