[Actions] Create Encrich PR Action (#64)

Author: onairmarc

.github/workflows/_release.yml

@@ -23,6 +23,8 @@ jobs:
                         imageName: 'gh-action-create-github-release'
                     -   actionPath: 'actions/github/jsonDiffAlert'
                         imageName: 'gh-action-json-diff-alert'
+                    -   actionPath: 'actions/github/enrichPullRequest'
+                        imageName: 'gh-action-enrich-pull-request'
         uses: ./.github/workflows/_github_createAndReleaseActionDockerImage.yml
         with:
             actionPath: ${{ matrix.actionPath }}

actions/github/enrichPullRequest/Dockerfile

@@ -0,0 +1,41 @@
+FROM golang:1.24-alpine AS builder
+
+WORKDIR /app
+
+# Copy go mod and sum files
+COPY go.mod go.sum ./
+
+# Download dependencies
+RUN go mod download
+
+# Copy source code
+COPY . .
+
+# Build the binary
+RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o main .
+
+# Final stage - minimal image
+FROM alpine:latest
+
+# Install ca-certificates for HTTPS requests
+RUN apk --no-cache add ca-certificates
+
+# Create a non-root user
+RUN addgroup -g 1001 -S appgroup && \
+    adduser -u 1001 -S appuser -G appgroup
+
+# Set working directory
+WORKDIR /app
+
+# Copy the binary from builder stage
+COPY --from=builder /app/main .
+
+# Set ownership and permissions
+RUN chown appuser:appgroup /app/main && \
+    chmod +x /app/main
+
+# Switch to non-root user
+USER appuser
+
+# Run the binary
+ENTRYPOINT ["/app/main"]

actions/github/enrichPullRequest/action.yml

@@ -0,0 +1,74 @@
+name: 'Enrich Pull Request'
+description: "Enrich's the pull request with information from your project management system."
+inputs:
+    repository:
+        description: 'The repository name'
+        required: true
+        type: string
+    pullRequestNumber:
+        description: 'The pull request number'
+        required: true
+        type: string
+    branch:
+        description: 'The branch name'
+        required: true
+        type: string
+    token:
+        description: 'GitHub token'
+        required: true
+    customFormatting:
+        description: "User defined custom formatting rules for specific words."
+        required: false
+        default: ""
+    strategy:
+        type: string
+        description: 'Which formatting strategy should be used'
+        required: false
+        default: 'branch-name'
+    jiraURL:
+        type: string
+        description: 'URL to your jira instance'
+        required: false
+        default: ''
+    jiraEmail:
+        type: string
+        description: 'Jira auth email'
+        required: false
+        default: ''
+    jiraToken:
+        type: string
+        description: 'Jira auth token'
+        required: false
+        default: ''
+    jiraEnableSyncLabel:
+        type: boolean
+        description: 'Use a sync label'
+        required: false
+        default: true
+    jiraEnableSyncDescription:
+        type: boolean
+        description: 'Sync Jira description to PR description'
+        required: false
+        default: true
+    jiraSyncLabelName:
+        type: string
+        description: 'Name of the sync label'
+        required: false
+        default: 'jira-sync-complete'
+runs:
+    using: 'docker'
+    image: 'docker://ghcr.io/encoredigitalgroup/gh-action-enrich-pull-request:latest'
+    env:
+        GH_TOKEN: ${{ inputs.token }}
+        GH_REPOSITORY: ${{ inputs.repository }}
+        PR_NUMBER: ${{ inputs.pullRequestNumber }}
+        BRANCH_NAME: ${{ inputs.branch }}
+        ENABLE_EXPERIMENTS: ${{ inputs.enableExperiments }}
+        OPT_FMT_WORDS: ${{ inputs.customFormatting }}
+        OPT_FMT_STRATEGY: ${{ inputs.strategy }}
+        OPT_JIRA_URL: ${{ inputs.jiraURL }}
+        OPT_JIRA_EMAIL: ${{ inputs.jiraEmail }}
+        OPT_JIRA_TOKEN: ${{ inputs.jiraToken }}
+        OPT_ENABLE_JIRA_SYNC_LABEL: ${{ inputs.jiraEnableSyncLabel }}
+        OPT_JIRA_SYNC_LABEL_NAME: ${{ inputs.jiraSyncLabelName }}
+        OPT_ENABLE_JIRA_SYNC_DESCRIPTION: ${{ inputs.jiraEnableSyncDescription }}

actions/github/enrichPullRequest/drivers/branch_name/branch_name.go

@@ -0,0 +1,65 @@
+package branchname
+
+import (
+    "fmt"
+    "os"
+    "regexp"
+
+    "github.com/EncoreDigitalGroup/golib/logger"
+
+    "github.com/EncoreDigitalGroup/ci-workflows/actions/github/enrichPullRequest/support/github"
+)
+
+var regexWithIssueType = regexp.MustCompile(`^(epic|feature|bugfix|hotfix)/([A-Z]+-[0-9]+)-(.+)$`)
+var regexWithoutIssueType = regexp.MustCompile(`^([A-Z]+-[0-9]+)-(.+)$`)
+var pullRequestTitle string
+
+func Format(gh github.GitHub) {
+    branchName, err := gh.GetBranchName()
+    if err != nil {
+        logger.Error(err.Error())
+        os.Exit(1)
+    }
+
+    if !gh.BranchNameMatchesPRTitle(branchName) {
+        formattedTitle := formatTitle(gh, branchName)
+        gh.UpdatePRTitle(formattedTitle)
+    }
+}
+
+func GetIssueKeyFromBranchName(branchName string) (string, error) {
+    if matches := regexWithIssueType.FindStringSubmatch(branchName); matches != nil {
+        return matches[2], nil
+    } else if matches := regexWithoutIssueType.FindStringSubmatch(branchName); matches != nil {
+        return matches[1], nil
+    } else {
+        fmt.Println("Title does not match expected format")
+        logger.Info(pullRequestTitle)
+        return "", nil
+    }
+}
+
+func GetIssueNameFromBranchName(branchName string) (string, error) {
+    if matches := regexWithIssueType.FindStringSubmatch(branchName); matches != nil {
+        return matches[3], nil
+    } else if matches := regexWithoutIssueType.FindStringSubmatch(branchName); matches != nil {
+        return matches[2], nil
+    } else {
+        fmt.Println("Title does not match expected format")
+        logger.Info(pullRequestTitle)
+        return "", nil
+    }
+}
+
+func formatTitle(gh github.GitHub, branchName string) string {
+    issueKey, err := GetIssueKeyFromBranchName(branchName)
+    issueName, err := GetIssueNameFromBranchName(branchName)
+
+    if err != nil {
+        fmt.Println("Title does not match expected format")
+        logger.Error(err.Error())
+        return pullRequestTitle
+    }
+
+    return gh.ApplyFormatting(issueKey, issueName)
+}

actions/github/enrichPullRequest/drivers/drivers.go

@@ -0,0 +1,19 @@
+package drivers
+
+const BranchName = "branch-name"
+const Jira = "jira"
+
+func Validate(driver string) bool {
+    validDrivers := []string{
+        BranchName,
+        Jira,
+    }
+
+    for _, validDriver := range validDrivers {
+        if driver == validDriver {
+            return true
+        }
+    }
+
+    return false
+}