Skip to content

[INF] Update default references to main branch to latest release #866

Open
@oliverholworthy

Description

@oliverholworthy

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.

Stable Branch

  • 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)

Updates to repos with these two workflows:

Documentation

Add a latest or stable folder in the docs corresponding to the latest tagged release. As a replacement for the main branch.

Other

There may be some other references to the main branch that are not covered by the above

Metadata

Metadata

Labels

choreInfrastructure update

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions