You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The merlin repositories use the main branch for development. Merging features into this branch before publishing a package from the release branches created.
Reducing the chances of people running or viewing the development version of our code will reduce the chance of errors surfacing from features that are not currently released.
Repository Default Branch
Motivation
Example notebooks are published alongside our code in each repository.
Initial exporation of Merlin packages often involves exploring the example notebooks. Which can happen via Google Colab (which has integration with GitHub (using the default branch unless changed via the branch drop-down). Or from a git clone.
When using the development branch, often the notebooks can result in errors due to enhancements or bug fixes that require unreleased Merlin code.
Proposed Change
Trial this with a couple of repositories first: Transformers4Rec, Merlin Models
Change the default branch from main to the release branch corresponding to the latest release (e.g. release-23.02)
GitHub doesn't have a mechanism to provide a different default branch for Pull Requests from the default branch used for viewing/cloning the repository.
Creating a GitHub Actions Workflow to check that the base branch of a Pull Request is the development branch (currently main). Raising an error if not. With the option to skip this check with a particular label
Add a stable branch that get's set automatically to correspond with the latest release tag
Add Check for PRs to ensure they're configured with a base development branch ref. (For the case where this stable branch is used as the default of the repo)
The merlin repositories use the
main
branch for development. Merging features into this branch before publishing a package from the release branches created.Reducing the chances of people running or viewing the development version of our code will reduce the chance of errors surfacing from features that are not currently released.
Repository Default Branch
Motivation
Example notebooks are published alongside our code in each repository.
Initial exporation of Merlin packages often involves exploring the example notebooks. Which can happen via Google Colab (which has integration with GitHub (using the default branch unless changed via the branch drop-down). Or from a git clone.
When using the development branch, often the notebooks can result in errors due to enhancements or bug fixes that require unreleased Merlin code.
Proposed Change
Trial this with a couple of repositories first: Transformers4Rec, Merlin Models
main
to the release branch corresponding to the latest release (e.g.release-23.02
)main
). Raising an error if not. With the option to skip this check with a particular labelStable Branch
stable
branch that get's set automatically to correspond with the latest release tagUpdates to repos with these two workflows:
Documentation
Add a
latest
orstable
folder in the docs corresponding to the latest tagged release. As a replacement for themain
branch.Other
There may be some other references to the main branch that are not covered by the above
The text was updated successfully, but these errors were encountered: