Skip to content

Commit fdb4b67

Browse files
committed
mark methods as deprecated
Signed-off-by: Moritz Wiesinger <[email protected]>
1 parent 69b84eb commit fdb4b67

File tree

4 files changed

+10
-1
lines changed

4 files changed

+10
-1
lines changed

cmd/githubgen/codeowners.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ type codeownersGenerator struct {
7474
skipGithub bool
7575
}
7676

77+
// Deprecated: generate is deprecated. Please use the new githubgen tool
78+
// from https://github.com/open-telemetry/opentelemetry-go-build-tools/
7779
func (cg codeownersGenerator) generate(data *githubData) error {
7880
allowlistData, err := os.ReadFile(data.allowlistFilePath)
7981
if err != nil {

cmd/githubgen/distributions.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ type distOutput struct {
2121
Components map[string][]string `yaml:"components"`
2222
}
2323

24+
// Deprecated: generate is deprecated. Please use the new githubgen tool
25+
// from https://github.com/open-telemetry/opentelemetry-go-build-tools/
2426
func (cg distributionsGenerator) generate(data *githubData) error {
2527
for _, dist := range data.distributions {
2628
components := map[string][]string{}

cmd/githubgen/issuetemplates.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ func folderToShortName(folder string) string {
3333

3434
type issueTemplatesGenerator struct{}
3535

36+
// Deprecated: generate is deprecated. Please use the new githubgen tool
37+
// from https://github.com/open-telemetry/opentelemetry-go-build-tools/
3638
func (itg issueTemplatesGenerator) generate(data *githubData) error {
3739
keys := map[string]struct{}{}
3840
for _, f := range data.folders {

cmd/githubgen/main.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,14 @@ type generator interface {
2525
generate(data *githubData) error
2626
}
2727

28-
// Generates files specific to Github according to status metadata:
28+
// main generates files specific to Github according to status metadata:
2929
// .github/CODEOWNERS
3030
// .github/ALLOWLIST
3131
// .github/ISSUE_TEMPLATES/*.yaml (list of components)
3232
// reports/distributions/*
33+
//
34+
// Deprecated: generate is deprecated. Please use the new githubgen tool
35+
// from https://github.com/open-telemetry/opentelemetry-go-build-tools/
3336
func main() {
3437
fmt.Println("[DEPRECATED] this tool is now deprecated. Please make sure to install go.opentelemetry.io/build-tools/githubgen instead")
3538
folder := flag.String("folder", ".", "folder investigated for codeowners")

0 commit comments

Comments
 (0)