Allow custom templates for messages, branches and PRs by EyalDelarea · Pull Request #307 · jfrog/frogbot

EyalDelarea · 2023-04-18T17:37:18Z

All tests passed. If this feature is not already covered by the tests, I added new tests.
This pull request is on the dev branch.
I used gofmt for formatting the code before submitting the pull request.

Allow custom formats for Commits, Branches and Pull requests titles.
Don't fix indirect dependencies unless there is a specific implementation.
Update Frogbot badges

Exmaple:

Given templates:

  branchNameTemplate: "${BRANCH_NAME_HASH} this is custom branch ${IMPACTED_PACKAGE} to ${FIX_VERSION}"

  commitTitleTemplate: "fix(dep) this is my custom commit \n update ${IMPACTED_PACKAGE} to ${FIX_VERSION} "
  
  pullRequestTitleTemplate: "(dependency) new pull request by frogbot,fixing ${IMPACTED_PACKAGE}"

commands/createfixpullrequests.go

commands/createfixpullrequests_test.go

github-actions · 2023-04-18T18:43:06Z

What is Frogbot?

eyalbe4

I haven't finished reviewing all the code. I'll resume my review soon, but I'm releasingwhat I have so far.

commands/utils/consts.go

commands/utils/git.go

commands/utils/params.go

commands/utils/utils.go

eyalbe4 · 2023-04-19T06:28:38Z

commands/utils/utils.go

+	if len(branchName) == 0 {
+		return nil
+	}
+	invalidChars := regexp.MustCompile(BranchNameRegex)


The compile operation is expensive, and it is therefore better to do it once only.

commands/utils/utils_test.go

commands/createfixpullrequests.go

eyalbe4 · 2023-04-19T06:47:02Z

commands/createfixpullrequests_test.go

 		{"dev", "replace:colons:colons", "3.0.0", "frogbot-replace_colons_colons-89e555131b4a70a32fe9d9c44d6ff0fc"},
 	}
-
+	gitManager := utils.GitManager{}


This line is redundant. Yuo can replace gitManager with utils.GitManager{} in line 212.

It doesn't let me run it like that.
And they are all the same so we can create it just once :)

eyalbe4 · 2023-04-19T07:08:27Z

docs/templates/.frogbot/frogbot-config.yml

+      # [Optional] Custom formats for commits, branches, and PR created by Frogbot.
+      customFormats:
+        # Please note, Frogbot will replace the following placeholders
+        # 1. IMPACTED_PACKAGE
+        # 2. FIX_VERSION
+        # Example branchName:"(MyLabel):Vulnerability_fix_IMPACTED_PACKAGE_to_version_FIX_VERSION"
+
+        commitTitle: ""
+
+        pullRequestTitle: ""
+
+        branchName: ""


I suggest changing the template to be -

- params: # Git parameters git: # [Mandatory] # Name of the git repository to scan repoName: repo-name # [Mandatory] # List of branches to scan branches: - master # [Optional] Template for the branch name generated by Frogbot when creating pull requests with fixes. The template must include ${BRANCH_NAME_HASH}, to ensure that the generated branch name is unique # branchNameTemplate: "" # [Optional] Template for the commit message generated by Frogbot when creating pull requests with fixes # commitMessageTemplate: "" # [Optional] Template for the pull request title generated by Frogbot when creating pull requests with fixes. The template can optionally include the following variables: # ${IMPACTED_PACKAGE} # ${FIX_VERSION} # pullRequestTitleTemplate: ""

Let's add our default values for each variable instead of the existing empty string.

schema/frogbot-schema.json

eyalbe4

I'm done reviewing everything.

I suggest that you first read all of my comments before working o fixing them, beucase some of them are related to each other.
While suggesting the changes to the frogbot-config.yml file, I realized that the proper term for for the new config items is actiually not "format" but "template". Let's therefore change all the structs' name to reflect that.
We still need to update all the workflow templates with the new variables. Let's do it in a follow-up pull request.
I'd be happy to review everything again once done.

EyalDelarea · 2023-04-19T08:55:53Z

docs/templates/.frogbot/frogbot-config.yml

      branches:
        - master

+      # [Optional] Template for the branch name generated by Frogbot when creating pull requests with fixes.The template must include ${BRANCH_NAME_HASH}, to ensure that the generated branch name is unique


Maybe we should explain the placeholder in the start here?
because they can be used in every template

Suggestion:

Suggested change

# [Optional] Template for the branch name generated by Frogbot when creating pull requests with fixes.The template must include ${BRANCH_NAME_HASH}, to ensure that the generated branch name is unique

# [Optional] Git templates, each template can include the following variables:

# ${IMPACTED_PACKAGE}

# ${FIX_VERSION}

# [Optional] Template for the branch name generated by Frogbot when creating pull requests with fixes.The template must include ${BRANCH_NAME_HASH}, to ensure that the generated branch name is unique

branchNameTemplate: ""

# [Optional] Template for the commit message generated by Frogbot when creating pull requests with fixes

CommitMessageTemplate: ""

# [Optional] Template for the pull request title generated by Frogbot when creating pull requests with fixes.The template can optionally include the following variables:

pullRequestTitleTemplate: ""

Let's think about it after the release.

github-actions · 2023-04-19T09:08:02Z

What is Frogbot?

eyalbe4 · 2023-04-19T11:20:20Z

commands/utils/git.go

+	commitMessageTemplate string
+	// New branch name template
+	branchNameTemplate string
+	// New pullRequestTitleTemplate title template


// New pullRequestTitleTemplate title template
-->
// New pull request title template

eyalbe4 · 2023-04-19T11:28:07Z

commands/utils/utils.go

+	BranchInvalidChars    = "branch name cannot contain the following chars  ~, ^, :, ?, *, [, ], @, {, }"
+	BranchInvalidPrefix   = "branch name cannot start with '-' "
+	BranchCharsMaxLength  = 255
+	BranchInvalidLength   = "branch name length exceeded " + string(rune(BranchCharsMaxLength)) + " chars"
+	InvalidBranchTemplate = "branch template must contain " + BranchHashPlaceHolder + " placeholder "


The above consts can be made private,

eyalbe4 · 2023-04-19T11:30:58Z

commands/utils/utils.go

+	if len(branchName) == 0 {
+		return nil
+	}
+	invalidChars := regexp.MustCompile(branchNameRegex)


As I suggest before, MustCompile should berun only once. You can therefore have a private const that is initialized with regexp.MustCompile(branchNameRegex).

eyalbe4 · 2023-04-19T11:32:39Z

commands/utils/utils_test.go

 	return
 }
+
+func TestIsValidBranchName(t *testing.T) {


TestIsValidBranchName --> TestValidatedBranchName
(the test name should match the function name, which is validateBranchName).

eyalbe4 · 2023-04-19T11:33:45Z

commands/utils/utils.go

 	return candidateMajorVersion != currentMajorVersion
 }
+
+func ValidateBranchName(branchName string) error {


This function can be made private,

eyalbe4 · 2023-04-19T11:39:11Z

docs/templates/.frogbot/frogbot-config.yml

      branches:
        - master

+      # [Optional] Template for the branch name generated by Frogbot when creating pull requests with fixes.The template must include ${BRANCH_NAME_HASH}, to ensure that the generated branch name is unique


Let's think about it after the release.

eyalbe4 · 2023-04-19T11:40:39Z

docs/templates/.frogbot/frogbot-config.yml

        - master

+      # [Optional] Template for the branch name generated by Frogbot when creating pull requests with fixes.The template must include ${BRANCH_NAME_HASH}, to ensure that the generated branch name is unique
+      branchNameTemplate: ""


Let's put this line as a comment (with a # prefix) and set the default value as the value.
The same goes for the two templates below.

github-actions · 2023-04-19T12:52:09Z

What is Frogbot?

EyalDelarea added 4 commits April 18, 2023 20:03

move fixversionInfo to utils

749a84c

insert formats

230f545

Don't fix indirect dependencies unless specific implementation

ed452f7

Update badges

0d72ade

EyalDelarea added the improvement Automatically generated release notes label Apr 18, 2023

EyalDelarea requested a review from eyalbe4 April 18, 2023 17:37

EyalDelarea had a problem deploying to frogbot April 18, 2023 17:37 — with GitHub Actions Failure

EyalDelarea commented Apr 18, 2023

View reviewed changes

commands/createfixpullrequests.go Show resolved Hide resolved

EyalDelarea commented Apr 18, 2023

View reviewed changes

commands/createfixpullrequests_test.go Show resolved Hide resolved

Fix tests

7ad80ae

EyalDelarea had a problem deploying to frogbot April 18, 2023 17:41 — with GitHub Actions Failure

eyalbe4 added new feature Automatically generated release notes safe to test Approve running integration tests on a pull request and removed improvement Automatically generated release notes labels Apr 18, 2023

github-actions bot removed the safe to test Approve running integration tests on a pull request label Apr 18, 2023

eyalbe4 changed the title ~~Custom git formats~~ Allow custom formats for messages, branches and PRs Apr 19, 2023

eyalbe4 suggested changes Apr 19, 2023

View reviewed changes

attiasas mentioned this pull request Apr 19, 2023

Update Frogbot badge to PNG in README.md jfrog/jfrog-vscode-extension#331

Merged

2 tasks

eyalbe4 suggested changes Apr 19, 2023

View reviewed changes

CR notes

f924540

EyalDelarea had a problem deploying to frogbot April 19, 2023 08:23 — with GitHub Actions Failure

Refactor

7e90574

EyalDelarea had a problem deploying to frogbot April 19, 2023 08:31 — with GitHub Actions Failure

Schema spaces

7b1a55c

EyalDelarea had a problem deploying to frogbot April 19, 2023 08:35 — with GitHub Actions Failure

Adjust test

60a00c2

EyalDelarea had a problem deploying to frogbot April 19, 2023 08:37 — with GitHub Actions Failure

uncapitalized error strings

abe42e7

EyalDelarea had a problem deploying to frogbot April 19, 2023 08:40 — with GitHub Actions Failure

remove redundant error returns

20c8550

EyalDelarea had a problem deploying to frogbot April 19, 2023 08:45 — with GitHub Actions Failure

Rename

4d42cb6

EyalDelarea temporarily deployed to frogbot April 19, 2023 08:52 — with GitHub Actions Inactive

EyalDelarea commented Apr 19, 2023

View reviewed changes

EyalDelarea requested a review from eyalbe4 April 19, 2023 08:56

EyalDelarea linked an issue Apr 19, 2023 that may be closed by this pull request

Allow to configure the commit messages style #263

Closed

Rename CommitTitleTemplate to CommitMessageTemplate

742c780

EyalDelarea had a problem deploying to frogbot April 19, 2023 09:27 — with GitHub Actions Failure

Rename CommitTitleTemplate to CommitMessageTemplate

9aac288

EyalDelarea had a problem deploying to frogbot April 19, 2023 09:29 — with GitHub Actions Failure

capital letter

0e34a22

EyalDelarea had a problem deploying to frogbot April 19, 2023 09:39 — with GitHub Actions Failure

eyalbe4 changed the title ~~Allow custom formats for messages, branches and PRs~~ Allow custom templates for messages, branches and PRs Apr 19, 2023

eyalbe4 suggested changes Apr 19, 2023

View reviewed changes

CR Notes

fbbdfd3

EyalDelarea had a problem deploying to frogbot April 19, 2023 11:55 — with GitHub Actions Failure

Update dependencies

cc35af6

EyalDelarea temporarily deployed to frogbot April 19, 2023 12:50 — with GitHub Actions Inactive

EyalDelarea merged commit e0ab27d into jfrog:dev Apr 19, 2023

-      # [Optional] Template for the branch name generated by Frogbot when creating pull requests with fixes.The template must include ${BRANCH_NAME_HASH}, to ensure that the generated branch name is unique
+      # [Optional] Git templates, each template can include the following variables:
+      # ${IMPACTED_PACKAGE}
+      # ${FIX_VERSION}
+      # [Optional] Template for the branch name generated by Frogbot when creating pull requests with fixes.The template must include ${BRANCH_NAME_HASH}, to ensure that the generated branch name is unique
+      branchNameTemplate: ""
+      # [Optional] Template for the commit message generated by Frogbot when creating pull requests with fixes
+      CommitMessageTemplate: ""
+      # [Optional] Template for the pull request title generated by Frogbot when creating pull requests with fixes.The template can optionally include the following variables:
+      pullRequestTitleTemplate: ""

Conversation

EyalDelarea commented Apr 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 18, 2023

Uh oh!

eyalbe4 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

eyalbe4 left a comment

Choose a reason for hiding this comment

Uh oh!

EyalDelarea Apr 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 19, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

EyalDelarea commented Apr 18, 2023 •

edited

Loading

EyalDelarea Apr 19, 2023 •

edited

Loading