github.com/blend/go-sdk@v1.20220411.3/codeowners/constants.go (about)

     1  /*
     2  
     3  Copyright (c) 2022 - Present. Blend Labs, Inc. All rights reserved
     4  Use of this source code is governed by a MIT license that can be found in the LICENSE file.
     5  
     6  */
     7  
     8  package codeowners
     9  
    10  const (
    11  	// DefaultPath is the default realized codeowners path.
    12  	DefaultPath = "./.github/CODEOWNERS"
    13  	// DefaultGithubURL is the default github url.
    14  	DefaultGithubURL = "https://git.blendlabs.com"
    15  	// DefaultGithubTokenEnvVar standardizes an environment variable
    16  	// to read the github api token from.
    17  	DefaultGithubTokenEnvVar = "GHE_TOKEN"
    18  )
    19  
    20  const (
    21  	// OwnersFile is the per path owners file users can create.
    22  	OwnersFile = ".codeowners"
    23  
    24  	// OwnersFileHeader is the header that is prefixed to the generated
    25  	// owners file.
    26  	OwnersFileHeader = `# CODEOWNERS automatically generated by 'codeowners'. DO NOT EDIT.
    27  # https://github.com/blog/2392-introducing-code-owners
    28  # https://help.github.com/articles/about-codeowners/
    29  #
    30  # Code owners named in each entry are automatically requested for review
    31  # when someone opens a pull request that modifies code that they own.
    32  #
    33  # Remember, *the last rule to match wins.*
    34  `
    35  
    36  	// OwnersGoCommentPrefix is the prefix for owners hints within go files.
    37  	OwnersGoCommentPrefix = "github:codeowner"
    38  	// OwnersFileSourceComment is the owners file comment marking the beginning
    39  	// of a section for a given source.
    40  	OwnersFileSourceComment = "# source: "
    41  	// OwnersFileSourceEndComment is the owners file comment marking the end
    42  	// of a section for a given source.
    43  	OwnersFileSourceEndComment = "# source-end: "
    44  )