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

Support hidden branches feature #8355

Open
N-o-Z opened this issue Nov 8, 2024 · 0 comments
Open

Support hidden branches feature #8355

N-o-Z opened this issue Nov 8, 2024 · 0 comments
Labels
new-feature Issues that introduce new feature or capability P2

Comments

@N-o-Z
Copy link
Member

N-o-Z commented Nov 8, 2024

In many scenarios, internal lakeFS flows requires creation of ephemeral branches. These branches should not be visible to the users to avoid confusion/friction or accidentally disrupting lakeFS flows (by user modification or deletion).
The suggestion is to allow creation of hidden branches which will not show up when listing repository branches and minimize the exposure of these branches to the end user.

Introduce a new flag for branch creation:

    BranchCreation:
      type: object
      required:
        - name
        - source
      properties:
        name:
          type: string
        source:
          type: string
        force:
          type: boolean
          default: false
        hidden:
          type: boolean
          description: when true, branch will not show in list branches by default
          default: false

Add hidden property to branch which will be defaulted to false if not exists (backwards compatible):

message BranchData {
  string id = 1;
  string commit_id = 2;
  string staging_token = 3;
  repeated string sealed_tokens = 4;
  bool hidden = 5;
}

These branches will not show up when listing repository branches by default. Introduce a new query param to ListBranches command:

        - in: query
          name: show_hidden
          schema:
            type: boolean
            default: false
            description: list all branches including hidden branches
  • Hidden branches will still be available for GetBranch operation regardless of hidden state.
  • ATM we will not allow modifying the hidden state of branches
@N-o-Z N-o-Z added the new-feature Issues that introduce new feature or capability label Nov 8, 2024
@talSofer talSofer added the P2 label Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-feature Issues that introduce new feature or capability P2
Projects
None yet
Development

No branches or pull requests

2 participants