Merge pull request #4 from paopa/feat/scopes

feat: support to specify scopes

Author: levivannoort

README.md

@@ -2,7 +2,7 @@
 
 The `pull-request-title-validator` GitHub Action helps ensuring that contributors provide informative and well-formatted titles - based on the [conventional-commits] specification. The titles of the pull request could then be used to create automated releases.
 
-[conventional-commits]: https://www.conventionalcommits.org/en/v1.0.0/ 
+[conventional-commits]: https://www.conventionalcommits.org/en/v1.0.0/
 
 ## Example title
 
@@ -18,6 +18,7 @@ feat(client): add component
 The action can be used with both the `pull_request` and `pull_request_target` trigger.
 
 `default`
+
 ```yaml
 name: validate-pull-request-title
 
@@ -41,6 +42,7 @@ jobs:
 ```
 
 `custom types`
+
 ```yaml
 name: validate-pull-request-title
 
@@ -64,3 +66,29 @@ jobs:
         with:
           types: "fix,feat,chore"
 ```
+
+`custom scopes`
+
+```yaml
+name: validate-pull-request-title
+
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+permissions:
+  pull-requests: read
+
+jobs:
+  validator:
+    name: validate-pull-request-title
+    runs-on: ubuntu-latest
+    steps:
+      - name: validate pull request title
+        uses: kontrolplane/pull-request-title-validator@v1.2.0
+        with:
+          scopes: "api,lang,parser"
+```

main.go

@@ -25,6 +25,7 @@ func main() {
 	githubEventName := os.Getenv("GITHUB_EVENT_NAME")
 	githubEventPath := os.Getenv("GITHUB_EVENT_PATH")
 	conventionTypes := parseTypes(os.Getenv("INPUT_TYPES"), defaultConventionTypes)
+	scopes := parseScopes(os.Getenv("INPUT_SCOPES"))
 
 	if githubEventName != "pull_request" && githubEventName != "pull_request_target" {
 		fmt.Printf("Error: the 'pull_request' trigger type should be used, received '%s'\n", githubEventName)
@@ -39,6 +40,11 @@ func main() {
 		os.Exit(1)
 	}
 
+	if err := checkAgainstScopes(titleScope, scopes); err != nil && len(scopes) > 1 {
+		fmt.Println(err)
+		os.Exit(1)
+	}
+
 	fmt.Printf("commit title type used: %s\n", titleType)
 	fmt.Printf("commit title scope used: %s\n", titleScope)
 	fmt.Printf("commit title message used: %s\n\n", titleMessage)
@@ -106,6 +112,16 @@ func checkAgainstConventionTypes(titleType string, conventionTypes []string) err
 	return fmt.Errorf("the type passed '%s' is not present in the types allowed by the convention: %s", titleType, conventionTypes)
 }
 
+func checkAgainstScopes(titleScope string, scopes []string) error {
+	for _, scope := range scopes {
+		if titleScope == scope {
+			return nil
+		}
+	}
+
+	return fmt.Errorf("the scope '%s' is not allowed. Please choose from the following scopes: %s", titleScope, scopes)
+}
+
 func parseTypes(input string, fallback []string) []string {
 	if input == "" {
 		fmt.Println("no custom list of commit types was passed using fallback.")
@@ -120,3 +136,18 @@ func parseTypes(input string, fallback []string) []string {
 	}
 	return types
 }
+
+func parseScopes(input string) []string {
+	if input == "" {
+		fmt.Println("no custom list of commit scopes was passed using fallback.")
+		return []string{}
+	}
+	scopes := strings.Split(input, ",")
+	for i := range scopes {
+		scopes[i] = strings.TrimSpace(scopes[i])
+	}
+	if len(scopes) == 0 {
+		return []string{}
+	}
+	return scopes
+}