Merge pull request #69 from fullstack-devops/feature/issue-#58

get pr by merge sha + override a release branch

Author: eksrha

docs/commands/release.md

@@ -29,7 +29,9 @@ awesome-ci release <subcommand> [subcommand-option]
 | `-version`          | overrides any version from git and, or patches the given string             |
 | `-patchLevel`       | overrides the patchLevel. make shure your following the alias definition.   |
 | `-dry-run`          | doesn't create a release. Prints out what it would do and check permissions |
-| `-body`             | add a text (markdown) to the release body                                   |
+| `-body`             | add a text (markdown) to the release body eg.: `./release-template-md`      |
+| `-merge-sha`        | specify the merge sha                                                       |
+| `-release-branch`   | set release branch (default: git default)                                   |
 | `-assets`           | (only available in publish) uploads the given Artifacts to a release. Eg.: `file=out/awesome-ci` |
 | `-releaseid`        | (only available in publish) publishes an early defined release              |
 

docs/examples/github_actions.md

@@ -52,7 +52,7 @@ jobs:
       - name: collect infos and create release
         run: |
           awesome-ci pr info
-          awesome-ci release create # making a draft
+          awesome-ci release create -merge-sha $\{\{ github.sha \}\}
         env:
           GITHUB_TOKEN: $\{\{ secrets.GITHUB_TOKEN \}\}
 

main.go

@@ -56,6 +56,8 @@ func init() {
 	}
 	releaseSet.Create.Fs = flag.NewFlagSet("release create", flag.ExitOnError)
 	releaseSet.Create.Fs.IntVar(&releaseSet.Create.PrNumber, "prnumber", 0, "overwrite the issue number")
+	releaseSet.Create.Fs.StringVar(&releaseSet.Create.MergeCommitSHA, "merge-sha", "", "set the merge sha")
+	releaseSet.Create.Fs.StringVar(&releaseSet.Create.ReleaseBranch, "release-branch", "", "set release branch (default: git default)")
 	releaseSet.Create.Fs.StringVar(&releaseSet.Create.Version, "version", "", "override version to Update")
 	releaseSet.Create.Fs.StringVar(&releaseSet.Create.Body, "body", "", "custom release message (markdow string or file)")
 	releaseSet.Create.Fs.StringVar(&releaseSet.Create.PatchLevel, "patchLevel", "", "predefine version to Update")
@@ -66,6 +68,8 @@ func init() {
 	}
 	releaseSet.Publish.Fs = flag.NewFlagSet("release publish", flag.ExitOnError)
 	releaseSet.Publish.Fs.IntVar(&releaseSet.Publish.PrNumber, "prnumber", 0, "overwrite the issue number")
+	releaseSet.Publish.Fs.StringVar(&releaseSet.Publish.MergeCommitSHA, "merge-sha", "", "set the merge sha")
+	releaseSet.Publish.Fs.StringVar(&releaseSet.Publish.ReleaseBranch, "release-branch", "", "set release branch (default: git default)")
 	releaseSet.Publish.Fs.StringVar(&releaseSet.Publish.Version, "version", "", "override version to Update")
 	releaseSet.Publish.Fs.StringVar(&releaseSet.Publish.Body, "body", "", "custom release message (markdow string or file)")
 	releaseSet.Publish.Fs.StringVar(&releaseSet.Publish.PatchLevel, "patchLevel", "", "predefine version to Update")
@@ -114,7 +118,7 @@ func printNoValidCommand(usage func()) {
 func main() {
 	flag.Usage = func() {
 		fmt.Println("awesome-ci makes your CI easy.")
-		fmt.Println("  Find more information and examples at: https://github.com/eksrvb/awesome-ci")
+		fmt.Println("  Find more information and examples at: https://github.com/fullstack-devops/awesome-ci")
 		fmt.Println()
 		fmt.Println("Available commands:")
 		fmt.Println("  release")

release-template.md

@@ -1,3 +1,5 @@
 ## Awesome-CI
 
-this project is still in the beta phase. But don't be shy and use this tool in advance. If you find bugs or have improvements, please feel free to open an [issue](https://github.com/fullstack-devops/awesome-ci/issues/new/choose) :rocket:
+This project is still in the **beta** phase.
+
+But don't be shy and use this tool in advance. If you find bugs or have improvements, please feel free to open an [issue](https://github.com/fullstack-devops/awesome-ci/issues/new/choose) :rocket:

src/acigithub/pullrequest.go

@@ -12,7 +12,7 @@ import (
 )
 
 // GetPrInfos need the PullRequest-Number
-func GetPrInfos(prNumber int) (standardPrInfos *models.StandardPrInfos, prInfos *github.PullRequest, err error) {
+func GetPrInfos(prNumber int, mergeCommitSha string) (standardPrInfos *models.StandardPrInfos, prInfos *github.PullRequest, err error) {
 	if !isgithubRepository {
 		log.Fatalln("make shure the GITHUB_REPOSITORY is available!")
 	}
@@ -23,6 +23,35 @@ func GetPrInfos(prNumber int) (standardPrInfos *models.StandardPrInfos, prInfos
 			return nil, nil, fmt.Errorf("could not load any information about the given pull request  %d: %v", prNumber, err)
 		}
 	}
+	if mergeCommitSha != "" && prNumber == 0 {
+		prOpts := github.PullRequestListOptions{
+			State:     "all",
+			Sort:      "updated",
+			Direction: "desc",
+			ListOptions: github.ListOptions{
+				PerPage: 10,
+			},
+		}
+		pullRequests, _, err := GithubClient.PullRequests.List(ctx, owner, repo, &prOpts)
+		if err != nil {
+			return nil, nil, fmt.Errorf("could not load any information about the given pull request  %d: %v", prNumber, err)
+		}
+		var found int = 0
+		for _, pr := range pullRequests {
+			fmt.Println(*pr.MergeCommitSHA == mergeCommitSha, *pr.MergeCommitSHA)
+			if *pr.MergeCommitSHA == mergeCommitSha {
+				prInfos = pr
+				found = found + 1
+			}
+		}
+		if found > 1 {
+			return nil, nil, fmt.Errorf("found more than one pull request, this should not be possible. please open an issue with all log files")
+		}
+	}
+
+	if prInfos == nil {
+		return nil, nil, fmt.Errorf("no pull request found, please check if all resources are specified")
+	}
 
 	prSHA := *prInfos.Head.SHA
 	branchName := *prInfos.Head.Ref
@@ -62,6 +91,7 @@ func GetPrInfos(prNumber int) (standardPrInfos *models.StandardPrInfos, prInfos
 		LatestVersion:  *repositoryRelease.TagName,
 		CurrentVersion: "",
 		NextVersion:    nextVersion,
+		MergeCommitSha: *prInfos.MergeCommitSHA,
 	}
 	return
 }

src/acigithub/release.go

@@ -12,14 +12,16 @@ import (
 )
 
 // CreateRelease
-func CreateRelease(version string, body string, draft bool) (createdRelease *github.RepositoryRelease, err error) {
+func CreateRelease(version string, releaseBranch string, body string, draft bool) (createdRelease *github.RepositoryRelease, err error) {
 	if !isgithubRepository {
 		log.Fatalln("make shure the GITHUB_REPOSITORY is available!")
 	}
 	owner, repo := tools.DevideOwnerAndRepo(githubRepository)
 
 	relName := "Release " + version
-	defaultBranch := tools.GetDefaultBranch()
+	if releaseBranch == "" {
+		releaseBranch = tools.GetDefaultBranch()
+	}
 
 	// get body for release
 	if body != "" {
@@ -30,7 +32,7 @@ func CreateRelease(version string, body string, draft bool) (createdRelease *git
 	}
 
 	releaseObject := github.RepositoryRelease{
-		TargetCommitish: &defaultBranch,
+		TargetCommitish: &releaseBranch,
 		TagName:         &version,
 		Name:            &relName,
 		Draft:           &draft,
@@ -56,7 +58,7 @@ func CreateRelease(version string, body string, draft bool) (createdRelease *git
 }
 
 // PublishRelease
-func PublishRelease(version string, body string, releaseId int64, uploadArtifacts *string) (err error) {
+func PublishRelease(version string, releaseBranch string, body string, releaseId int64, uploadArtifacts *string) (err error) {
 	draftFalse := false
 	if !isgithubRepository {
 		log.Fatalln("make shure the GITHUB_REPOSITORY is available!")
@@ -67,7 +69,7 @@ func PublishRelease(version string, body string, releaseId int64, uploadArtifact
 		releaseIdStr, releaseIdBool := os.LookupEnv("ACI_RELEASE_ID")
 		if !releaseIdBool {
 			log.Println("No release found, creating one...")
-			release, err := CreateRelease(version, body, false)
+			release, err := CreateRelease(version, releaseBranch, body, true)
 			if err != nil {
 				log.Fatalln(err)
 			}
@@ -92,7 +94,7 @@ func PublishRelease(version string, body string, releaseId int64, uploadArtifact
 
 	// upload any given artifacts
 	var releaseBodyAssets string = ""
-	if uploadArtifacts != nil {
+	if *uploadArtifacts != "" {
 		filesAndInfos, err := tools.GetAsstes(uploadArtifacts, false)
 		if err != nil {
 			return err

src/models/models.go

@@ -11,4 +11,5 @@ type StandardPrInfos struct {
 	Sha            string
 	ShaShort       string
 	BranchName     string
+	MergeCommitSha string
 }

src/service/pullrequest.go

@@ -21,22 +21,17 @@ type PullRequestInfoSet struct {
 }
 
 func PrintPRInfos(args *PullRequestInfoSet) {
-	var prNumber int
 	_, err := acigithub.NewGitHubClient()
 	if err != nil {
 		log.Fatalln(err)
 	}
 
-	if args.Number == 0 {
-		prNumber, err = evalPrNumber(&args.Number)
-		if err != nil {
-			log.Fatalln(err)
-		}
-	} else {
-		prNumber = args.Number
+	err = evalPrNumber(&args.Number)
+	if err != nil {
+		log.Fatalln(err)
 	}
 
-	prInfos, _, err := acigithub.GetPrInfos(prNumber)
+	prInfos, _, err := acigithub.GetPrInfos(args.Number, "")
 	if err != nil {
 		log.Fatalln(err)
 	}

src/service/release.go

@@ -19,23 +19,27 @@ type ReleaseSet struct {
 }
 
 type ReleaseCreateSet struct {
-	Fs         *flag.FlagSet
-	Version    string
-	PatchLevel string
-	PrNumber   int
-	DryRun     bool
-	Body       string
+	Fs             *flag.FlagSet
+	Version        string
+	PatchLevel     string
+	PrNumber       int
+	MergeCommitSHA string
+	ReleaseBranch  string
+	DryRun         bool
+	Body           string
 }
 
 type ReleasePublishSet struct {
-	Fs         *flag.FlagSet
-	Version    string
-	PatchLevel string
-	ReleaseId  int64
-	Assets     string
-	PrNumber   int
-	DryRun     bool
-	Body       string
+	Fs             *flag.FlagSet
+	Version        string
+	PatchLevel     string
+	ReleaseId      int64
+	Assets         string
+	PrNumber       int
+	MergeCommitSHA string
+	ReleaseBranch  string
+	DryRun         bool
+	Body           string
 }
 
 func ReleaseCreate(args *ReleaseCreateSet) {
@@ -53,22 +57,28 @@ func ReleaseCreate(args *ReleaseCreateSet) {
 	} else if args.Version != "" && args.PatchLevel == "" {
 		version = args.Version
 	} else {
-		prNumber, err := evalPrNumber(&args.PrNumber)
-		if err != nil {
-			log.Fatalln(err)
+		// if no merge commit sha is provided, the pull request number should either be specified or evaluated from the merge message (fallback)
+		if args.MergeCommitSHA == "" {
+			err := evalPrNumber(&args.PrNumber)
+			if err != nil {
+				log.Fatalln(err)
+			}
 		}
-		prInfos, _, err := acigithub.GetPrInfos(prNumber)
+		prInfos, _, err := acigithub.GetPrInfos(args.PrNumber, args.MergeCommitSHA)
 		if err != nil {
 			log.Fatalln(err)
 		}
 		version = prInfos.NextVersion
+		if errEnvs := standardPrInfosToEnv(prInfos); errEnvs != nil {
+			log.Fatalln(errEnvs)
+		}
 	}
 
 	if args.DryRun {
 		fmt.Printf("Would create new release with version: %s\n", version)
 	} else {
 		fmt.Printf("Writing new release: %s\n", version)
-		createdRelease, err := acigithub.CreateRelease(version, args.Body, true)
+		createdRelease, err := acigithub.CreateRelease(version, args.ReleaseBranch, args.Body, true)
 		if err != nil {
 			log.Fatalln(err)
 		}
@@ -91,15 +101,21 @@ func ReleasePublish(args *ReleasePublishSet) {
 	} else if args.Version != "" && args.PatchLevel == "" {
 		version = args.Version
 	} else if args.ReleaseId == 0 {
-		prNumber, err := evalPrNumber(&args.PrNumber)
-		if err != nil {
-			log.Fatalln(err)
+		// if no merge commit sha is provided, the pull request number should either be specified or evaluated from the merge message (fallback)
+		if args.MergeCommitSHA == "" {
+			err := evalPrNumber(&args.PrNumber)
+			if err != nil {
+				log.Fatalln(err)
+			}
 		}
-		prInfos, _, err := acigithub.GetPrInfos(prNumber)
+		prInfos, _, err := acigithub.GetPrInfos(args.PrNumber, args.MergeCommitSHA)
 		if err != nil {
 			log.Fatalln(err)
 		}
 		version = prInfos.NextVersion
+		if errEnvs := standardPrInfosToEnv(prInfos); errEnvs != nil {
+			log.Fatalln(errEnvs)
+		}
 	}
 
 	if args.Assets != "" {
@@ -113,26 +129,22 @@ func ReleasePublish(args *ReleasePublishSet) {
 		fmt.Printf("Would publishing release: %s\n", version)
 	} else {
 		fmt.Printf("Publishing release: %s - %d\n", version, args.ReleaseId)
-		err = acigithub.PublishRelease(version, args.Body, args.ReleaseId, &args.Assets)
+		err = acigithub.PublishRelease(version, args.ReleaseBranch, args.Body, args.ReleaseId, &args.Assets)
 		if err != nil {
 			log.Fatalln(err)
 		}
 	}
 }
 
-func evalPrNumber(override *int) (prNumber int, err error) {
+func evalPrNumber(override *int) (err error) {
 	if *override != 0 {
-		return *override, nil
+		return nil
 	}
 
-	prNumber, err = getPrFromMergeMessage()
+	*override, err = getPrFromMergeMessage()
 	if err != nil {
-		log.Fatalln(err)
+		return err
 	}
-
-	/* if prNumber == 0 {
-		// tags, _, _ := CiEnvironment.Clients.GithubClient.Repositories.ListTags()
-	} */
 	return
 }
 
@@ -146,6 +158,7 @@ func getPrFromMergeMessage() (pr int, err error) {
 	} else {
 		return 0, errors.New("No PR found in merge message pls make shure this regex matches: " + regex +
 			"\nExample: Merge pull request #3 from some-orga/feature/awesome-feature" +
-			"\nIf you like to set your patch level manually by flag: -level (feautre|bugfix)")
+			"\nIf you like to set your patch level manually by flag: -level (feautre|bugfix)" +
+			"\nOr use the -merge-sha option!")
 	}
 }

src/service/service.go

@@ -47,6 +47,7 @@ func standardPrInfosToEnv(prInfos *models.StandardPrInfos) (err error) {
 		envVars.Set("ACI_PATCH_LEVEL", prInfos.PatchLevel)
 		envVars.Set("ACI_VERSION", prInfos.NextVersion)
 		envVars.Set("ACI_LATEST_VERSION", prInfos.LatestVersion)
+		envVars.Set("ACI_MERGE_COMMIT_SHA", prInfos.MergeCommitSha)
 		err = envVars.SaveEnvFile()
 		if err != nil {
 			return err