ci: update issue templates and secret scanning workflow

- Rename bug.yml to bug-report.yml for better clarity
- Add feature-request.yml and typo.yml templates for new issue types
- Update config.yml to reference new issue templates
- Modify secret-check.yml workflow to use TruffleHog main branch
- Adjust workflow to run on pull_request and push events
- Remove unnecessary comments and update template content

Signed-off-by: guanguans <[email protected]>

Author: guanguans

.chglog/CHANGELOG.tpl.md

@@ -12,7 +12,8 @@ All notable changes to this project will be documented in this file.
 {{ range .Unreleased.CommitGroups -}}
 ### {{ .Title }}
 {{ range .Commits -}}
-- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
+
+- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }} ([{{ .Hash.Short }}]({{ $.Info.RepositoryURL }}/commit/{{ .Hash.Short }}))
 {{ end }}
 {{ end -}}
 {{ end -}}
@@ -24,7 +25,8 @@ All notable changes to this project will be documented in this file.
 {{ range .CommitGroups -}}
 ### {{ .Title }}
 {{ range .Commits -}}
-- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
+
+- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }} ([{{ .Hash.Short }}]({{ $.Info.RepositoryURL }}/commit/{{ .Hash.Short }}))
 {{ end }}
 {{ end -}}
 

.chglog/config.yml

@@ -1,10 +1,15 @@
 style: github
+# https://github.com/garden-io/garden/tree/main/.chglog
+# https://github.com/git-chglog/git-chglog
+# https://github.com/quay/clair/tree/main/.chglog
 template: CHANGELOG.tpl.md
 info:
   title: CHANGELOG
   repository_url: https://github.com/guanguans/notify
 options:
+  sort: semver
   commits:
+    sort_by: Scope
     filters:
       Type:
         - build
@@ -19,20 +24,53 @@ options:
         - style
         - test
   commit_groups:
+    group_by: Type
+    sort_by: Custom
+    title_order:
+      # https://github.com/fobgochod/git-commit-message-format/blob/main/src/main/resources/messages/GitBundle.properties#L37
+      - feat
+      - fix
+      - docs
+      - style
+      - refactor
+      - perf
+      - test
+      - build
+      - ci
+      - chore
+      - revert
     title_maps:
-      chore: Chores
-      ci: CI
-      feat: Features
-      fix: Bug Fixes
-      perf: Performance Improvements
-      refactor: Code Refactoring
-      test: Tests
+      # https://github.com/antfu/changelogithub/blob/main/src/config.ts
+      # https://github.com/unjs/changelogen/blob/main/src/config.ts
+      # https://gitmoji.dev/
+      build: 📦 Builds
+      chore: 🏡 Chores
+      ci: 🤖 Continuous Integrations
+      docs: 📖 Documents
+      feat: ✨ Features # 🚀 Enhancements
+      fix: 🐞 Bug Fixes
+      perf: 🏎 Performance Improvements
+      refactor: 💅 Code Refactorings
+      revert: ⏪️ Reverts
+      style: 🎨 Styles
+      test: ✅ Tests
+
+      examples: 🏀 Examples
+      types: 🌊 Types
   header:
     pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?\\:\\s(.*)$"
     pattern_maps:
       - Type
       - Scope
       - Subject
+  issues:
+    prefix:
+      - "#"
+  refs:
+    actions:
+      - Closes
+      - Fixes
+      - PullRequest
   notes:
     keywords:
       - BREAKING CHANGE

.github/ISSUE_TEMPLATE/bug.yml renamed to .github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,4 +1,5 @@
 name: Bug Report
+# https://github.com/spatie/package-skeleton-php/tree/main/.github/ISSUE_TEMPLATE
 description: Report an Issue or Bug with the Package
 title: "[Bug]: "
 labels: [ "bug" ]
@@ -63,4 +64,4 @@ body:
       label: Notes
       description: Use this field to provide any other notes that you feel might be relevant to the issue.
     validations:
-      required: false
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -1,4 +1,5 @@
 blank_issues_enabled: false
+# https://github.com/spatie/package-skeleton-php/tree/main/.github/ISSUE_TEMPLATE
 contact_links:
   - name: Ask a question
     url: https://github.com/guanguans/notify/discussions/new?category=q-a
@@ -8,4 +9,4 @@ contact_links:
     about: Share ideas for new features
   - name: Report a security issue
     url: https://github.com/guanguans/notify/security/policy
-    about: Learn how to notify us for sensitive bugs
+    about: Learn how to notify us for sensitive bugs

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,45 @@
+name: 🚀 New feature proposal
+# https://github.com/antfu/.github/tree/main/.github/ISSUE_TEMPLATE
+description: Propose a new feature
+labels: [ enhancement ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for your interest in the project and taking the time to fill out this feature report!
+  - type: textarea
+    id: feature-description
+    attributes:
+      label: Clear and concise description of the problem
+      description: 'As a developer using this project I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description. Thanks!'
+    validations:
+      required: true
+  - type: textarea
+    id: suggested-solution
+    attributes:
+      label: Suggested solution
+      description: 'In module [xy] we could provide following implementation...'
+    validations:
+      required: true
+  - type: textarea
+    id: alternative
+    attributes:
+      label: Alternative
+      description: Clear and concise description of any alternative solutions or features you've considered.
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Any other context or screenshots about the feature request here.
+  - type: checkboxes
+    id: checkboxes
+    attributes:
+      label: Validations
+      description: Before submitting the issue, please make sure you do the following
+      options:
+        - label: Follow our [Code of Conduct](https://github.com/guanguans/notify/blob/master/.github/CODE_OF_CONDUCT.md)
+          required: true
+        - label: Read the [Contributing Guide](https://github.com/guanguans/notify/blob/master/.github/CONTRIBUTING.md).
+          required: true
+        - label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
+          required: true

.github/ISSUE_TEMPLATE/typo.yml

@@ -0,0 +1,16 @@
+name: 👀 Typo / Grammar fix
+# https://github.com/antfu/.github/tree/main/.github/ISSUE_TEMPLATE
+description: You can just go ahead and send a PR! Thank you!
+labels: [ ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## PR Welcome!
+
+        If the typo / grammar issue is trivial and straightforward, you can help by **directly sending a quick pull request**!
+        If you spot multiple of them, we suggest combining them into a single PR. Thanks!
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context

.github/workflows/secret-check.yml

@@ -1,6 +1,9 @@
 name: secrets check
 
-on: [ workflow_dispatch, push ]
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
 
 jobs:
   security-check:
@@ -9,12 +12,13 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
-#          ref: ${{ github.ref_name }}
+          # ref: ${{ github.ref_name }}
           fetch-depth: 0
-      - name: TruffleHog OSS
-        uses: trufflesecurity/trufflehog@v3.88.30
+      - name: Secret Scanning
+        uses: trufflesecurity/trufflehog@main
         with:
-#          path: ./
-#          base: ${{ github.event.repository.default_branch }}
-#          head: ${{ github.ref_name }}
-          extra_args: --debug --only-verified
+          # path: ./
+          # base: ${{ github.event.repository.default_branch }}
+          # head: ${{ github.ref_name }}
+          # extra_args: --results=verified,unknown --only-verified --debug
+          extra_args: --results=verified,unknown