@@ -40,7 +40,7 @@ import (
40
40
"sigs.k8s.io/release-sdk/github"
41
41
"sigs.k8s.io/release-utils/command"
42
42
"sigs.k8s.io/release-utils/editor"
43
- "sigs.k8s.io/release-utils/util "
43
+ "sigs.k8s.io/release-utils/helpers "
44
44
45
45
"k8s.io/release/pkg/notes"
46
46
"k8s.io/release/pkg/notes/document"
@@ -323,14 +323,14 @@ func runReleaseNotes() (err error) {
323
323
324
324
// createDraftPR pushes the release notes draft to the users fork.
325
325
func createDraftPR (repoPath , tag string ) (err error ) {
326
- tagVersion , err := util .TagStringToSemver (tag )
326
+ tagVersion , err := helpers .TagStringToSemver (tag )
327
327
if err != nil {
328
328
return fmt .Errorf ("reading tag: %s: %w" , tag , err )
329
329
}
330
330
331
331
// From v1.20.0 on we use the previous minor as a starting tag
332
332
// for the Release Notes draft because the branch is fast-rowarded now:
333
- start := util .SemverToTagString (semver.Version {
333
+ start := helpers .SemverToTagString (semver.Version {
334
334
Major : tagVersion .Major ,
335
335
Minor : tagVersion .Minor - 1 ,
336
336
Patch : 0 ,
@@ -389,13 +389,13 @@ func createDraftPR(repoPath, tag string) (err error) {
389
389
390
390
// Check if the directory exists
391
391
releaseDir := filepath .Join (sigReleaseRepo .Dir (), releasePath )
392
- if ! util .Exists (releaseDir ) {
392
+ if ! helpers .Exists (releaseDir ) {
393
393
return fmt .Errorf ("could not find release directory %s" , releaseDir )
394
394
}
395
395
396
396
// If we got the --fix flag, start the fix flow
397
397
if releaseNotesOpts .fixNotes {
398
- _ , _ , err = util .Ask ("Press enter to start" , "y:yes|n:no|y" , 10 )
398
+ _ , _ , err = helpers .Ask ("Press enter to start" , "y:yes|n:no|y" , 10 )
399
399
// In interactive mode, we will ask the user before sending the PR
400
400
autoCreatePullRequest = false
401
401
@@ -461,7 +461,7 @@ func createDraftPR(repoPath, tag string) (err error) {
461
461
462
462
// If we are in interactive mode, ask before continuing
463
463
if ! autoCreatePullRequest {
464
- _ , autoCreatePullRequest , err = util .Ask ("Create pull request with your changes? (y/n)" , "y:Y:yes|n:N:no|y" , 10 )
464
+ _ , autoCreatePullRequest , err = helpers .Ask ("Create pull request with your changes? (y/n)" , "y:Y:yes|n:N:no|y" , 10 )
465
465
if err != nil {
466
466
return fmt .Errorf ("while asking to create pull request: %w" , err )
467
467
}
@@ -578,7 +578,7 @@ func createDraftCommit(repo *git.Repo, releasePath, commitMessage string) error
578
578
// Add to the PR all files that exist
579
579
for _ , dirData := range releaseDirectories {
580
580
// add the updated maps
581
- if util .Exists (filepath .Join (repo .Dir (), dirData .Path )) {
581
+ if helpers .Exists (filepath .Join (repo .Dir (), dirData .Path )) {
582
582
// Check if there are any files to commit
583
583
matches , err := filepath .Glob (filepath .Join (repo .Dir (), dirData .Path , "*" + dirData .Ext ))
584
584
logrus .Debugf ("Adding %d %s from %s to commit" , len (matches ), dirData .Name , dirData .Path )
@@ -690,7 +690,7 @@ func processJSONOutput(repoPath string) error {
690
690
691
691
// createWebsitePR creates the JSON version of the release notes and pushes them to a user fork.
692
692
func createWebsitePR (repoPath , tag string ) (err error ) {
693
- _ , err = util .TagStringToSemver (tag )
693
+ _ , err = helpers .TagStringToSemver (tag )
694
694
if err != nil {
695
695
return fmt .Errorf ("reading tag: %s: %w" , tag , err )
696
696
}
@@ -819,7 +819,7 @@ func tryToFindLatestMinorTag() (string, error) {
819
819
func releaseNotesJSON (repoPath , tag string ) (jsonString string , err error ) {
820
820
logrus .Infof ("Generating release notes for tag %s" , tag )
821
821
822
- tagVersion , err := util .TagStringToSemver (tag )
822
+ tagVersion , err := helpers .TagStringToSemver (tag )
823
823
if err != nil {
824
824
return "" , fmt .Errorf ("parsing semver from tag string: %w" , err )
825
825
}
@@ -876,14 +876,14 @@ func releaseNotesJSON(repoPath, tag string) (jsonString string, err error) {
876
876
if len (tagVersion .Pre ) == 2 && //nolint:gocritic // a switch case would not make it better
877
877
tagVersion .Pre [0 ].String () == "alpha" &&
878
878
tagVersion .Pre [1 ].VersionNum == 1 {
879
- startTag = util .SemverToTagString (semver.Version {
879
+ startTag = helpers .SemverToTagString (semver.Version {
880
880
Major : tagVersion .Major , Minor : tagVersion .Minor - 1 , Patch : 0 ,
881
881
})
882
882
tagChoice = "previous minor version"
883
883
} else if len (tagVersion .Pre ) == 0 && tagVersion .Patch == 0 {
884
884
// If we are writing the notes for the first minor version (eg 1.20.0)
885
885
// we choose as the start tag also the previous minor
886
- startTag = util .SemverToTagString (semver.Version {
886
+ startTag = helpers .SemverToTagString (semver.Version {
887
887
Major : tagVersion .Major , Minor : tagVersion .Minor - 1 , Patch : 0 ,
888
888
})
889
889
tagChoice = "previous minor version because we are in a new minor version"
@@ -917,7 +917,7 @@ func releaseNotesJSON(repoPath, tag string) (jsonString string, err error) {
917
917
fmt .Sprintf ("release-%d.%d" , tagVersion .Major , tagVersion .Minor ),
918
918
releaseNotesWorkDir , mapsMainDirectory ,
919
919
)
920
- if util .Exists (mapsDir ) {
920
+ if helpers .Exists (mapsDir ) {
921
921
logrus .Infof ("Notes gatherer will read maps from %s" , mapsDir )
922
922
notesOptions .MapProviderStrings = append (notesOptions .MapProviderStrings , mapsDir )
923
923
}
@@ -1020,7 +1020,7 @@ func (o *releaseNotesOptions) Validate() error {
1020
1020
}
1021
1021
1022
1022
// If a tag is defined, see if it is a valid semver tag
1023
- _ , err := util .TagStringToSemver (releaseNotesOpts .tag )
1023
+ _ , err := helpers .TagStringToSemver (releaseNotesOpts .tag )
1024
1024
if err != nil {
1025
1025
return fmt .Errorf ("reading tag: %s: %w" , releaseNotesOpts .tag , err )
1026
1026
}
@@ -1116,7 +1116,7 @@ func fixReleaseNotes(workDir string, releaseNotes *notes.ReleaseNotes) error {
1116
1116
}
1117
1117
1118
1118
// Check the workDir before going further
1119
- if ! util .Exists (workDir ) {
1119
+ if ! helpers .Exists (workDir ) {
1120
1120
return errors .New ("map directory does not exist" )
1121
1121
}
1122
1122
@@ -1151,9 +1151,9 @@ func fixReleaseNotes(workDir string, releaseNotes *notes.ReleaseNotes) error {
1151
1151
// Ask the user if they want to continue the last session o fix all notes
1152
1152
continueFromLastSession := true
1153
1153
if len (pullRequestChecklist ) > 0 {
1154
- _ , continueFromLastSession , err = util .Ask ("Would you like to continue from the last session? (Y/n)" , "y:Y:yes|n:N:no|y" , 10 )
1154
+ _ , continueFromLastSession , err = helpers .Ask ("Would you like to continue from the last session? (Y/n)" , "y:Y:yes|n:N:no|y" , 10 )
1155
1155
} else {
1156
- _ , _ , err = util .Ask ("Press enter to start editing" , "y:Y:yes|n:N:no|y" , 10 )
1156
+ _ , _ , err = helpers .Ask ("Press enter to start editing" , "y:Y:yes|n:N:no|y" , 10 )
1157
1157
}
1158
1158
1159
1159
if err != nil {
@@ -1232,13 +1232,13 @@ func fixReleaseNotes(workDir string, releaseNotes *notes.ReleaseNotes) error {
1232
1232
1233
1233
// Wrap the note for better readability on the terminal
1234
1234
fmt .Println (pointIfChanged ("Text" , note .Text , originalNote .Text ))
1235
- text := util .WrapText (note .Text , 80 )
1235
+ text := helpers .WrapText (note .Text , 80 )
1236
1236
fmt .Println (spacer + strings .ReplaceAll (text , nl , nl + spacer ))
1237
1237
1238
- _ , choice , err := util .Ask (fmt .Sprintf ("\n - Fix note for PR #%d? (y/N)" , note .PrNumber ), "y:Y:yes|n:N:no|n" , 10 )
1238
+ _ , choice , err := helpers .Ask (fmt .Sprintf ("\n - Fix note for PR #%d? (y/N)" , note .PrNumber ), "y:Y:yes|n:N:no|n" , 10 )
1239
1239
if err != nil {
1240
1240
// If the user cancelled with ctr+c exit and continue the PR flow
1241
- var userInputErr util .UserInputError
1241
+ var userInputErr helpers .UserInputError
1242
1242
if errors .As (err , & userInputErr ) && userInputErr .IsCtrlC () {
1243
1243
logrus .Info ("Input cancelled, exiting edit flow" )
1244
1244
@@ -1260,7 +1260,7 @@ func fixReleaseNotes(workDir string, releaseNotes *notes.ReleaseNotes) error {
1260
1260
if retry {
1261
1261
logrus .Error (err )
1262
1262
1263
- _ , retryEditingChoice , err := util .Ask (
1263
+ _ , retryEditingChoice , err := helpers .Ask (
1264
1264
fmt .Sprintf ("\n - An error occurred while editing PR #%d. Try again?" , note .PrNumber ),
1265
1265
"y:yes|n:no" , 10 ,
1266
1266
)
@@ -1521,7 +1521,7 @@ func createNotesWorkDir(releaseDir string) error {
1521
1521
filepath .Join (releaseDir , releaseNotesWorkDir , mapsSessionDirectory ), // Editing session files
1522
1522
filepath .Join (releaseDir , releaseNotesWorkDir , mapsThemesDirectory ), // Major themes directory
1523
1523
} {
1524
- if ! util .Exists (dirPath ) {
1524
+ if ! helpers .Exists (dirPath ) {
1525
1525
if err := os .Mkdir (dirPath , os .FileMode (0o755 )); err != nil {
1526
1526
return fmt .Errorf ("creating working directory: %w" , err )
1527
1527
}
@@ -1537,11 +1537,11 @@ func confirmWithUser(opts *releaseNotesOptions, question string) bool {
1537
1537
return true
1538
1538
}
1539
1539
1540
- _ , success , err := util .Ask (question + " (Y/n)" , "y:Y:yes|n:N:no|y" , 10 )
1540
+ _ , success , err := helpers .Ask (question + " (Y/n)" , "y:Y:yes|n:N:no|y" , 10 )
1541
1541
if err != nil {
1542
1542
logrus .Error (err )
1543
1543
1544
- var userInputErr util .UserInputError
1544
+ var userInputErr helpers .UserInputError
1545
1545
if errors .As (err , & userInputErr ) && userInputErr .IsCtrlC () {
1546
1546
os .Exit (1 )
1547
1547
}
0 commit comments