Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Logging skipped by pr description #117

Merged
merged 2 commits into from
Jul 15, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions service/hook/bitbucketv2/bitbucketv2.go
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,8 @@ func transformPullRequestEvent(pullRequest PullRequestEventModel) hookCommon.Tra
TriggeredBy: hookCommon.GenerateTriggeredBy(ProviderID, pullRequest.PullRequestInfo.Author.Nickname),
},
},
SkippedByPrDescription: !hookCommon.IsSkipBuildByCommitMessage(pullRequest.PullRequestInfo.Title) &&
hookCommon.IsSkipBuildByCommitMessage(pullRequest.PullRequestInfo.Description),
}
}

Expand Down
3 changes: 3 additions & 0 deletions service/hook/common/common.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ type TransformResultModel struct {
// but the handler won't wait for the response from the Trigger API,
// it'll respond immediately after calling the Trigger API
DontWaitForTriggerResponse bool
// Used for logging if only pull request description contains [skip ci] or
// [ci skip] but title doesn't
SkippedByPrDescription bool
}

// Provider ...
Expand Down
11 changes: 8 additions & 3 deletions service/hook/endpoint.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ import (
"net/http"
"net/url"

"github.com/gorilla/mux"
"github.com/pkg/errors"
"go.uber.org/zap"

"github.com/bitrise-io/api-utils/logging"
"github.com/bitrise-io/bitrise-webhooks/bitriseapi"
"github.com/bitrise-io/bitrise-webhooks/config"
Expand All @@ -23,9 +27,6 @@ import (
"github.com/bitrise-io/bitrise-webhooks/service/hook/slack"
"github.com/bitrise-io/bitrise-webhooks/service/hook/visualstudioteamservices"
"github.com/bitrise-io/go-utils/colorstring"
"github.com/gorilla/mux"
"github.com/pkg/errors"
"go.uber.org/zap"
)

func supportedProviders() map[string]hookCommon.Provider {
Expand Down Expand Up @@ -201,6 +202,10 @@ func HTTPHandler(w http.ResponseWriter, r *http.Request) {
return
}

if hookTransformResult.SkippedByPrDescription {
logger.Info(fmt.Sprintf("[skipped by pr description] app: %s, service: %s", appSlug, serviceID))
}

respondWith := hookCommon.TransformResponseInputModel{
Errors: []string{},
SuccessTriggerResponses: []bitriseapi.TriggerAPIResponseModel{},
Expand Down
2 changes: 2 additions & 0 deletions service/hook/github/github.go
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,8 @@ func transformPullRequestEvent(pullRequest PullRequestEventModel) hookCommon.Tra
TriggeredBy: hookCommon.GenerateTriggeredBy(ProviderID, pullRequest.Sender.Login),
},
},
SkippedByPrDescription: !hookCommon.IsSkipBuildByCommitMessage(pullRequest.PullRequestInfo.Title) &&
hookCommon.IsSkipBuildByCommitMessage(pullRequest.PullRequestInfo.Body),
}
}

Expand Down
11 changes: 8 additions & 3 deletions service/hook/gitlab/gitlab.go
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,8 @@ func transformMergeRequestEvent(mergeRequest MergeRequestEventModel) hookCommon.
TriggeredBy: hookCommon.GenerateTriggeredBy(ProviderID, mergeRequest.User.Username),
},
},
SkippedByPrDescription: !hookCommon.IsSkipBuildByCommitMessage(mergeRequest.ObjectAttributes.Title) &&
hookCommon.IsSkipBuildByCommitMessage(mergeRequest.ObjectAttributes.Description),
}
}

Expand Down Expand Up @@ -382,7 +384,8 @@ func (hp HookProvider) TransformRequest(r *http.Request) hookCommon.TransformRes
if err := json.NewDecoder(r.Body).Decode(&codePushEvent); err != nil {
return hookCommon.TransformResultModel{
DontWaitForTriggerResponse: true,
Error: fmt.Errorf("Failed to parse request body: %s", err)}
Error: fmt.Errorf("Failed to parse request body: %s", err),
}
}
}
return transformCodePushEvent(codePushEvent)
Expand All @@ -393,7 +396,8 @@ func (hp HookProvider) TransformRequest(r *http.Request) hookCommon.TransformRes
if err := json.NewDecoder(r.Body).Decode(&tagPushEvent); err != nil {
return hookCommon.TransformResultModel{
DontWaitForTriggerResponse: true,
Error: fmt.Errorf("Failed to parse request body: %s", err)}
Error: fmt.Errorf("Failed to parse request body: %s", err),
}
}
}
return transformTagPushEvent(tagPushEvent)
Expand All @@ -402,7 +406,8 @@ func (hp HookProvider) TransformRequest(r *http.Request) hookCommon.TransformRes
if err := json.NewDecoder(r.Body).Decode(&mergeRequestEvent); err != nil {
return hookCommon.TransformResultModel{
DontWaitForTriggerResponse: true,
Error: fmt.Errorf("Failed to parse request body as JSON: %s", err)}
Error: fmt.Errorf("Failed to parse request body as JSON: %s", err),
}
}

return transformMergeRequestEvent(mergeRequestEvent)
Expand Down