21 |
33 |
22 |
23 |
24 |
32 | {{ partial "title" . }}
6 | {{ partial "content" . }} 7 | ${1}
` | safeHTML -}}
4 | {{- $content -}}
5 |
--------------------------------------------------------------------------------
/pkg/jira/build_regex_test.go:
--------------------------------------------------------------------------------
1 | package jira
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/stretchr/testify/assert"
7 | )
8 |
9 | func TestBuildRegex(t *testing.T) {
10 | tests := map[string][]string{
11 | defaultJiraRegex: {},
12 | `(TEST|PROJ|FEOP)-[0-9]+`: {"TEST", "PROJ", "FEOP"},
13 | }
14 |
15 | for expected, test := range tests {
16 | assert.Equal(t, expected, buildRegex(test))
17 | }
18 | }
19 |
--------------------------------------------------------------------------------
/pkg/text/is_initial_commit.go:
--------------------------------------------------------------------------------
1 | package text
2 |
3 | import "regexp"
4 |
5 | var initCommitRegex = regexp.MustCompile(`^Initial .+`)
6 |
7 | // IsInitialCommit checks if a commit needs to be filtered, because it is the init commit of any given repo
8 | func IsInitialCommit(commitMessage string) bool{
9 | initCommitMatch := initCommitRegex.FindStringSubmatch(commitMessage)
10 |
11 | return initCommitMatch != nil
12 | }
13 |
--------------------------------------------------------------------------------
/pkg/text/is_merge_commit.go:
--------------------------------------------------------------------------------
1 | package text
2 |
3 | import (
4 | "regexp"
5 | )
6 |
7 | var mergeCommitRegex = regexp.MustCompile(`^Merge .+`)
8 |
9 | // IsMergeCommit tests message string against expected format of a merge commit and returns true/false based on it
10 | func IsMergeCommit(message string) bool {
11 | mergeCommitMatch := mergeCommitRegex.FindStringSubmatch(message)
12 |
13 | return mergeCommitMatch != nil
14 | }
15 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/shortcodes/tab.html:
--------------------------------------------------------------------------------
1 | {{ if .Parent }}
2 | {{ $name := .Get 0 }}
3 | {{ $group := printf "tabs-%s" (.Parent.Get 0) }}
4 |
5 | {{ if not (.Parent.Scratch.Get $group) }}
6 | {{ .Parent.Scratch.Set $group slice }}
7 | {{ end }}
8 |
9 | {{ .Parent.Scratch.Add $group (dict "Name" $name "Content" .Inner) }}
10 | {{ else }}
11 | {{ errorf "%q: 'tab' shortcode must be inside 'tabs' shortcode" .Page.Path }}
12 | {{ end}}
13 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/theme.toml:
--------------------------------------------------------------------------------
1 | name = "Geekdoc"
2 | license = "MIT"
3 | licenselink = "https://github.com/thegeeklab/hugo-geekdoc/blob/main/LICENSE"
4 | description = "Hugo theme made for documentation"
5 | homepage = "https://geekdocs.de/"
6 | demosite = "https://geekdocs.de/"
7 | tags = ["docs", "documentation", "responsive", "simple"]
8 | min_version = "0.83.0"
9 |
10 | [author]
11 | name = "Robert Kaussow"
12 | homepage = "https://thegeeklab.de/"
13 |
--------------------------------------------------------------------------------
/internal/dispatcher/handle_errors.go:
--------------------------------------------------------------------------------
1 | package dispatcher
2 |
3 | import (
4 | "sync"
5 |
6 | "github.com/apex/log"
7 | )
8 |
9 | func (dispatch *Dispatcher) handleErrors(
10 | wg *sync.WaitGroup,
11 | channel <-chan PipelineError,
12 | results *Results,
13 | ) {
14 | defer wg.Done()
15 |
16 | for message := range channel {
17 | log.Debugf("[%s] %s", message.PipelineName, message.Error)
18 |
19 | results.Errors = append(results.Errors, message)
20 | }
21 | }
22 |
--------------------------------------------------------------------------------
/action.yml:
--------------------------------------------------------------------------------
1 | name: "Commitsar Action"
2 | description: "Check commit message compliance with conventional commits"
3 | author: "Simon Prochazka"
4 | branding:
5 | icon: "code"
6 | color: "blue"
7 | inputs:
8 | config:
9 | description: "Path to the folder where your .commitsar.yaml is"
10 | required: false
11 | default: "."
12 | runs:
13 | using: "docker"
14 | image: "Dockerfile"
15 | args:
16 | - commitsar
17 | - "--config-path=${{ inputs.config }}"
18 |
--------------------------------------------------------------------------------
/docs/config.toml:
--------------------------------------------------------------------------------
1 | baseURL = "https://commitsar.aevea.ee"
2 | title = "Commitsar"
3 | theme = "hugo-geekdoc"
4 |
5 | pluralizeListTitles = false
6 |
7 | # Geekdoc required configuration
8 | pygmentsUseClasses = true
9 | pygmentsCodeFences = true
10 | disablePathToLower = true
11 |
12 | # Needed for mermaid shortcodes
13 | [markup]
14 | [markup.goldmark.renderer]
15 | # Needed for mermaid shortcode
16 | unsafe = true
17 | [markup.tableOfContents]
18 | startLevel = 1
19 | endLevel = 9
--------------------------------------------------------------------------------
/docs/content/usage/gobinaries.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: gobinaries
3 | title: GoBinaries
4 | ---
5 |
6 | Install commitsar on your machine using
9 | {{- .Inner -}}
10 |
11 |
--------------------------------------------------------------------------------
/internal/dispatcher/success_handler.go:
--------------------------------------------------------------------------------
1 | package dispatcher
2 |
3 | import (
4 | "sync"
5 |
6 | "github.com/apex/log"
7 | )
8 |
9 | func (dispatch *Dispatcher) handleSuccess(
10 | wg *sync.WaitGroup,
11 | channel <-chan PipelineSuccess,
12 | results *Results,
13 | ) {
14 | defer wg.Done()
15 |
16 | for message := range channel {
17 | log.Debugf("[%s] %s", message.PipelineName, message.Message)
18 |
19 | results.SuccessfulPipelines = append(results.SuccessfulPipelines, message)
20 | }
21 | }
22 |
--------------------------------------------------------------------------------
/pkg/jira/find_references.go:
--------------------------------------------------------------------------------
1 | package jira
2 |
3 | import (
4 | "regexp"
5 | )
6 |
7 | // FindReferences scans a given message looking for all issues that match the keys. Default to the JIRA default regex if no keys are provided.
8 | func FindReferences(keys []string, message string) ([]string, error) {
9 | regex, err := regexp.Compile(buildRegex(keys))
10 |
11 | if err != nil {
12 | return nil, err
13 | }
14 |
15 | matches := regex.FindAllString(message, -1)
16 |
17 | return matches, nil
18 | }
19 |
--------------------------------------------------------------------------------
/.github/workflows/semgrep.yml:
--------------------------------------------------------------------------------
1 | # name: Semgrep
2 | # on: [pull_request]
3 | # jobs:
4 | # semgrep:
5 | # name: Scan
6 | # runs-on: ubuntu-latest
7 | # steps:
8 | # - uses: actions/checkout@v1
9 | # - uses: returntocorp/semgrep-action@v1
10 | # env: # Optional environment variable for inline PR comments (beta)
11 | # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
12 | # with:
13 | # publishToken: ${{ secrets.SEMGREP_APP_TOKEN }}
14 | # publishDeployment: 174
15 |
--------------------------------------------------------------------------------
/internal/version_runner/version_runner.go:
--------------------------------------------------------------------------------
1 | package version_runner
2 |
3 | import "github.com/apex/log"
4 |
5 | // VersionInfo houses all info regarding to the version. It is here to avoid global variables in this package.
6 | type VersionInfo struct {
7 | Version string
8 | Date string
9 | }
10 |
11 | // Run executes the command to get version and prints it into stdout
12 | func Run(versionInfo VersionInfo) error {
13 | log.Infof("Commitsar version: %s\t Built on: %s", versionInfo.Version, versionInfo.Date)
14 | return nil
15 | }
16 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/static/print-f79fc3e5d7.min.css:
--------------------------------------------------------------------------------
1 | @media print{.editpage,.gdoc-footer .container span:not(:first-child),.gdoc-nav{display:none}.gdoc-footer{border-top:1px solid #dee2e6}.gdoc-markdown pre{white-space:pre-wrap;overflow-wrap:break-word}.chroma code{border:1px solid #dee2e6;padding:.5rem!important;font-weight:400!important}.gdoc-markdown code{font-weight:700}a,a:visited{color:inherit!important;text-decoration:none!important}.gdoc-toc{flex:none}.gdoc-toc nav{position:relative;width:auto}.wrapper{display:block}.wrapper main{display:block}}
--------------------------------------------------------------------------------
/.goreleaser.yml:
--------------------------------------------------------------------------------
1 | # yaml-language-server: $schema=https://goreleaser.com/static/schema.json
2 | # Make sure to check the documentation at https://goreleaser.com
3 | version: 2
4 |
5 | before:
6 | hooks:
7 | - go mod download
8 |
9 | builds:
10 | - env:
11 | - CGO_ENABLED=0
12 | main: ./main.go
13 | goos:
14 | - windows
15 | - linux
16 | - darwin
17 |
18 | checksum:
19 | name_template: "checksums.txt"
20 |
21 | snapshot:
22 | version_template: "{{ .Tag }}-next"
23 |
24 | changelog:
25 | disable: true
26 |
--------------------------------------------------------------------------------
/docs/content/usage/docker.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: docker
3 | title: Docker
4 | ---
5 |
6 | For running in docker just use the following command:
7 |
8 | ```sh
9 | docker run --rm --name="commitsar" -w /src -v "$(pwd)":/src aevea/commitsar
10 | ```
11 |
12 | ```sh
13 | docker run --rm --name="commitsar" -w /src -v "$(pwd)":/src aevea/commitsar ./path-to-repo
14 | ```
15 |
16 | Make sure to load the working directory where `.git` folder is present. Commitsar will not work without the `.git` folder. This can be overridden by setting the path argument.
17 |
--------------------------------------------------------------------------------
/docs/content/usage/gitlab.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: gitlab
3 | title: Gitlab CI
4 | ---
5 |
6 | For Gitlab usage you can include the following job:
7 |
8 | ```yaml
9 | validate-commits:
10 | stage: test
11 | image: aevea/commitsar
12 | script:
13 | - git fetch origin master
14 | - commitsar
15 | ```
16 |
17 | **Important** In case of an error such as: `reference not found` please set a higher `GIT_DEPTH` variable setting. Commitsar currently relies on full commit objects which do not get pulled in on the shallow clone that `GIT_DEPTH` uses.
18 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/partials/search.html:
--------------------------------------------------------------------------------
1 | {{ if default true .Site.Params.GeekdocSearch }}
2 |
3 |
4 |
6 |
7 |
9 | {{ end }}
10 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/static/js/groupBy-174feb11c7.min.js:
--------------------------------------------------------------------------------
1 | const groupBy=(r,...e)=>{let t=r.map(t=>e.map(e=>e(t))),a={};return t.forEach((e,t)=>{t=(_simpleAt(a,e)||[]).concat([r[t]]);_simpleSet(a,e,t)}),a},_isPlainObject=e=>null!=e&&"object"==typeof e&&e.constructor==Object,_parsePath=e=>Array.isArray(e)?e:`${e}`.split("."),_simpleAt=(e,t)=>_parsePath(t).reduce((e,t)=>null!=e&&e.hasOwnProperty(t)?e[t]:void 0,e),_simpleSet=(e,t,s)=>_parsePath(t).reduce((e,t,r,a)=>{a=r===a.length-1;return e.hasOwnProperty(t)&&(a||_isPlainObject(e[t]))||(e[t]={}),a?e[t]=s:e[t]},e);
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/shortcodes/expand.html:
--------------------------------------------------------------------------------
1 | {{ $id := substr (sha1 .Inner) 0 8 }}
2 |
12 |
--------------------------------------------------------------------------------
/pkg/text/is_revert_commit_test.go:
--------------------------------------------------------------------------------
1 | package text
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/stretchr/testify/assert"
7 | )
8 |
9 | func TestIsRevertCommit(t *testing.T) {
10 | tests := map[string]bool{
11 | "Revert some commit": true,
12 | "revert \"some commit\"": true,
13 | "chore: something\n": false,
14 | "fix: test": false,
15 | "fix: Kodiak style regex": false,
16 | }
17 |
18 | for test, expected := range tests {
19 | err := IsRevertCommit(test)
20 | assert.Equal(t, expected, err)
21 | }
22 | }
23 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/static/favicon/site.webmanifest:
--------------------------------------------------------------------------------
1 | {
2 | "name": "",
3 | "short_name": "",
4 | "icons": [
5 | {
6 | "src": "/favicon/android-chrome-192x192.png",
7 | "sizes": "192x192",
8 | "type": "image/png"
9 | },
10 | {
11 | "src": "/favicon/android-chrome-512x512.png",
12 | "sizes": "512x512",
13 | "type": "image/png"
14 | }
15 | ],
16 | "theme_color": "#2f333e",
17 | "background_color": "#2f333e",
18 | "display": "standalone"
19 | }
20 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/partials/head/meta.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | {{ $description := default (default .Site.Title .Site.Params.description) (default .Summary .Description) }}
6 | {{ $keywords := default .Site.Params.Keywords .Keywords }}
7 |
8 | {{ with $description }}
9 |
10 | {{ end }}
11 | {{ with $keywords }}
12 |
13 | {{ end }}
14 |
--------------------------------------------------------------------------------
/internal/version_runner/version_runner_test.go:
--------------------------------------------------------------------------------
1 | package version_runner
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/apex/log"
7 | "github.com/apex/log/handlers/memory"
8 | "github.com/stretchr/testify/assert"
9 | )
10 |
11 | func TestVersionRun(t *testing.T) {
12 | handler := memory.New()
13 |
14 | log.SetHandler(handler)
15 |
16 | err := Run(VersionInfo{
17 | Version: "development",
18 | Date: "2012-1-1",
19 | },
20 | )
21 |
22 | assert.NoError(t, err)
23 | assert.Equal(t, "Commitsar version: development\t Built on: 2012-1-1", handler.Entries[0].Message)
24 | }
25 |
--------------------------------------------------------------------------------
/pkg/jira/build_regex.go:
--------------------------------------------------------------------------------
1 | package jira
2 |
3 | import "strings"
4 |
5 | const (
6 | defaultJiraRegex = `([A-Z][A-Z0-9]{1,10}-[0-9]+)`
7 | )
8 |
9 | func buildRegex(keys []string) string {
10 | if len(keys) == 0 {
11 | return defaultJiraRegex
12 | }
13 |
14 | result := strings.Builder{}
15 |
16 | result.WriteString("(")
17 |
18 | for index, key := range keys {
19 | result.WriteString(key)
20 |
21 | if (index + 1) != len(keys) {
22 | result.WriteString("|")
23 | }
24 | }
25 |
26 | result.WriteString(")")
27 |
28 | result.WriteString("-[0-9]+")
29 |
30 | return result.String()
31 | }
32 |
--------------------------------------------------------------------------------
/docs/content/usage/binary.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: binary
3 | title: Binary
4 | ---
5 |
6 | Adjust for version and distribution. Please check [Releases](https://github.com/aevea/commitsar/releases).
7 |
8 | ```sh
9 | - curl -L -O https://github.com/aevea/commitsar/releases/download/v0.0.2/commitsar_v0.0.2_Linux_x86_64.tar.gz
10 | - tar -xzf commitsar_v0.0.2_Linux_x86_64.tar.gz
11 | - ./commitsar
12 | ```
13 |
14 | ```sh
15 | - curl -L -O https://github.com/aevea/commitsar/releases/download/v0.0.2/commitsar_v0.0.2_Linux_x86_64.tar.gz
16 | - tar -xzf commitsar_v0.0.2_Linux_x86_64.tar.gz
17 | - ./commitsar ./path-to-repo
18 | ```
19 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | define prepare_build_vars
2 | $(eval DATE_FLAG := -X 'main.date=$(shell date)')
3 | $(eval VERSION_FLAG=-X 'main.version=$(shell git name-rev --tags --name-only $(shell git rev-parse HEAD))')
4 | $(eval COMMIT_FLAG=-X 'main.commit=$(shell git rev-parse HEAD)')
5 | endef
6 |
7 | build/docker:
8 | $(call prepare_build_vars)
9 | CGO_ENABLED=0 go build -a -tags "osusergo netgo" --ldflags "${DATE_FLAG} ${VERSION_FLAG} ${COMMIT_FLAG}" -o build/commitsar ./main.go
10 |
11 | build/local:
12 | $(call prepare_build_vars)
13 | go build -a --ldflags "${DATE_FLAG} ${VERSION_FLAG} ${COMMIT_FLAG}" -o build/commitsar ./main.go
--------------------------------------------------------------------------------
/internal/prpipeline/pipeline.go:
--------------------------------------------------------------------------------
1 | package prpipeline
2 |
3 | type Options struct {
4 | // Path to the git repository
5 | Path string
6 | // Styles are the styles of PR title to enforce (can be multiple)
7 | Styles []PRStyle
8 | // Keys checks for required keys in the PR title
9 | Keys []string
10 | }
11 |
12 | // Pip
13 | type Pipeline struct {
14 | options Options
15 | }
16 |
17 | func New(options Options) (*Pipeline, error) {
18 | if options.Path == "" {
19 | options.Path = "."
20 | }
21 |
22 | return &Pipeline{options: options}, nil
23 | }
24 |
25 | func (pipeline *Pipeline) Name() string {
26 | return "pr-pipeline"
27 | }
28 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/shortcodes/include.html:
--------------------------------------------------------------------------------
1 | {{ $file := .Get "file" }}
2 | {{ $page := .Site.GetPage $file }}
3 | {{ $type := .Get "type" }}
4 | {{ $language := .Get "language" }}
5 | {{ $options :=.Get "options" }}
6 |
7 |
8 | {{- if (.Get "language") -}}
9 | {{- highlight ($file | readFile) $language (default "linenos=table" $options) -}}
10 | {{- else if eq $type "html" -}}
11 | {{- $file | readFile | safeHTML -}}
12 | {{- else if eq $type "page" -}}
13 | {{- with $page }}{{ .Content }}{{ end -}}
14 | {{- else -}}
15 | {{- $file | readFile | $.Page.RenderString -}}
16 | {{- end -}}
17 |
18 |
--------------------------------------------------------------------------------
/pkg/text/check_required_scopes.go:
--------------------------------------------------------------------------------
1 | package text
2 |
3 | import (
4 | "errors"
5 | )
6 |
7 | var errMissingRequiredScope = errors.New("required scope missing")
8 |
9 | // RequiredScopeChecker creates case sensitive strict checker, validating that
10 | // provided scope matches one from required scopes list
11 | func RequiredScopeChecker(requiredScopes []string) func(string) error {
12 | return func(scope string) error {
13 | if len(requiredScopes) < 1 {
14 | return nil
15 | }
16 |
17 | for _, rs := range requiredScopes {
18 | if scope == rs {
19 | return nil
20 | }
21 | }
22 |
23 | return errMissingRequiredScope
24 | }
25 | }
26 |
--------------------------------------------------------------------------------
/.github/workflows/goreleaser-check.yml:
--------------------------------------------------------------------------------
1 | name: GoReleaser Check
2 |
3 | on:
4 | pull_request:
5 | paths:
6 | - ".goreleaser.yml"
7 | - ".github/workflows/goreleaser-check.yml"
8 | push:
9 | branches:
10 | - master
11 | paths:
12 | - ".goreleaser.yml"
13 | - ".github/workflows/goreleaser-check.yml"
14 |
15 | jobs:
16 | check:
17 | runs-on: ubuntu-latest
18 | steps:
19 | - name: Check out code
20 | uses: actions/checkout@v6
21 |
22 | - name: Check GoReleaser config
23 | uses: goreleaser/goreleaser-action@v6
24 | with:
25 | version: latest
26 | args: check
27 |
--------------------------------------------------------------------------------
/docs/content/intro.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: intro
3 | title: Introduction
4 | slug: /
5 | ---
6 |
7 | Tool to make sure your commits are compliant with [conventional commits](https://www.conventionalcommits.org). It is aimed mainly at CIs to prevent branches with commits that don't comply. Usage as a pre-commit hook is also under consideration.
8 |
9 | ## Usage
10 |
11 | Commitsar is shipped as a Dockerfile. This is the easiest way to add it to your CI.
12 |
13 | **Important: Commitsar currently needs to be run in the same folder as the git repository you want checked, currently no override is provided for setting path to git repo see https://github.com/aevea/commitsar/issues/93**
14 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/shortcodes/tabs.html:
--------------------------------------------------------------------------------
1 | {{ if .Inner }}{{ end }}
2 | {{ $id := .Get 0 }}
3 | {{ $group := printf "tabs-%s" $id }}
4 |
5 |
6 | {{ range $index, $tab := .Scratch.Get $group }}
7 |
9 |
12 |
17 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/shortcodes/button.html:
--------------------------------------------------------------------------------
1 | {{ $ref := "" }}
2 | {{ $target := "" }}
3 | {{ $size := default "regular" (.Get "size" | lower) }}
4 |
5 | {{ if not (in (slice "regular" "large") $size) }}
6 | {{ $size = "regular" }}
7 | {{ end }}
8 |
9 | {{ with .Get "href" }}
10 | {{ $ref = . }}
11 | {{ $target = "_blank" }}
12 | {{ end }}
13 |
14 | {{ with .Get "relref" }}
15 | {{ $ref = relref $ . }}
16 | {{ end }}
17 |
18 |
23 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/partials/menu.html:
--------------------------------------------------------------------------------
1 |
20 |
--------------------------------------------------------------------------------
/internal/commitpipeline/log_branch_test.go:
--------------------------------------------------------------------------------
1 | package commitpipeline
2 |
3 | import (
4 | "testing"
5 |
6 | history "github.com/aevea/git/v4"
7 | "github.com/apex/log"
8 | "github.com/apex/log/handlers/memory"
9 | "github.com/stretchr/testify/assert"
10 | )
11 |
12 | func TestLogBranch(t *testing.T) {
13 | handler := memory.New()
14 |
15 | log.SetHandler(handler)
16 |
17 | runner, err := New(nil)
18 |
19 | assert.NoError(t, err)
20 |
21 | gitRepo, err := history.OpenGit("../../testdata/commits-on-master")
22 |
23 | assert.NoError(t, err)
24 |
25 | err = runner.logBranch(gitRepo)
26 |
27 | assert.NoError(t, err)
28 | assert.Equal(t, "Starting analysis of commits on branch refs/heads/master", handler.Entries[0].Message)
29 | }
30 |
--------------------------------------------------------------------------------
/internal/root_runner/root_runner.go:
--------------------------------------------------------------------------------
1 | package root_runner
2 |
3 | type Runner struct {
4 | }
5 |
6 | type RunnerOptions struct {
7 | // Path to repository
8 | Path string
9 | // UpstreamBranch is the branch against which to check
10 | UpstreamBranch string
11 | // Limit will limit how far back to check on upstream branch.
12 | Limit int
13 | // AllCommits will check all the commits on the upstream branch. Regardless of Limit setting.
14 | AllCommits bool
15 | Strict bool
16 | // RequiredScopes will check scope in commit message against list of required ones
17 | RequiredScopes []string
18 | }
19 |
20 | // New returns a new instance of a RootRunner with fallback for logging
21 | func New() *Runner {
22 |
23 | return &Runner{}
24 | }
25 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/partials/foot.html:
--------------------------------------------------------------------------------
1 | {{ if default true .Site.Params.GeekdocSearch }}
2 | {{ .Scratch.Set "geekdocSearchConfig" .Site.Params.GeekdocSearchConfig }}
3 |
4 | {{ $searchJSFile := printf "js/%s.search.js" .Language.Lang }}
5 | {{ $searchJS := resources.Get "js/search.js" | resources.ExecuteAsTemplate $searchJSFile . | resources.Minify | fingerprint }}
6 |
7 | {{ end }}
8 |
9 | {{ if default true .Site.Params.GeekdocAnchorCopy }}
10 |
11 |
12 | {{ end }}
13 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/shortcodes/katex.html:
--------------------------------------------------------------------------------
1 | {{ if not (.Page.Scratch.Get "katex") }}
2 |
3 |
4 |
5 |
6 |
7 | {{ .Page.Scratch.Set "katex" true }}
8 | {{ end }}
9 |
10 |
11 | {{ cond (in .Params "display") "\\[" "\\(" -}}
12 | {{- trim .Inner "\n" -}}
13 | {{- cond (in .Params "display") "\\]" "\\)" }}
14 |
15 |
--------------------------------------------------------------------------------
/internal/dispatcher/pipeline.go:
--------------------------------------------------------------------------------
1 | package dispatcher
2 |
3 | // Pipeliner interface describes the requirements for pipelines the dispatcher can run
4 | type Pipeliner interface {
5 | Name() string
6 | Run() (*PipelineSuccess, error)
7 | }
8 |
9 | // FailureData is used to build the table output
10 | // Example: "hash": "somehash". It is built as a struct to enforce order
11 | type FailureData struct {
12 | Name string
13 | Value string
14 | }
15 |
16 | // PipelineSuccess is returned by a pipeline if it encounters no errors
17 | type PipelineSuccess struct {
18 | PipelineName string
19 | Message string
20 | }
21 |
22 | // PipelineError is used to group errors based on PipelineName
23 | type PipelineError struct {
24 | PipelineName string
25 | Data []FailureData
26 | Error error
27 | }
28 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/posts/single.html:
--------------------------------------------------------------------------------
1 | {{ define "main" }}
2 |
13 | {{ .Content | $.Page.RenderString }}
14 |
15 | {{ end }}
16 | {{ .Title }}
5 |
6 |
7 |
13 |
14 |
16 | {{ partial "content" . }}
17 |
18 |
5 |
6 | {{ .Text | safeHTML }}
7 |
8 |
9 |
10 |
11 |
12 | {{- else -}}
13 |
14 |
15 | {{ .Text | safeHTML }}
16 |
17 |
18 | {{- end -}}
19 |
--------------------------------------------------------------------------------
/.github/workflows/build.yml:
--------------------------------------------------------------------------------
1 | name: Docker build
2 | on:
3 | push:
4 | branches:
5 | - master
6 | tags:
7 | - "v*"
8 |
9 | jobs:
10 | docker:
11 | runs-on: ubuntu-latest
12 | steps:
13 | - uses: actions/checkout@master
14 | - name: Kaniko build
15 | uses: aevea/action-kaniko@master
16 | with:
17 | image: aevea/commitsar
18 | username: ${{ secrets.DOCKERHUB_USERNAME }}
19 | password: ${{ secrets.DOCKERHUB_PASSWORD }}
20 | cache: true
21 | cache_registry: aevea/cache
22 | strip_tag_prefix: v
23 |
24 | - name: Sync Readme
25 | uses: ms-jpq/sync-dockerhub-readme@v1
26 | with:
27 | username: ${{ secrets.DOCKERHUB_USERNAME }}
28 | password: ${{ secrets.DOCKERHUB_PASSWORD }}
29 | repository: aevea/commitsar
30 | readme: "./README.md"
31 |
--------------------------------------------------------------------------------
/internal/dispatcher/work.go:
--------------------------------------------------------------------------------
1 | package dispatcher
2 |
3 | import (
4 | "sync"
5 |
6 | "github.com/apex/log"
7 | )
8 |
9 | func (dispatch *Dispatcher) work(
10 | wg *sync.WaitGroup,
11 | pipelineChannel chan Pipeliner,
12 | successChan chan PipelineSuccess,
13 | errorChannel chan PipelineError,
14 | ) {
15 | defer wg.Done()
16 | defer close(successChan)
17 | defer close(errorChannel)
18 |
19 | for {
20 | pipeline, more := <-pipelineChannel
21 |
22 | if more {
23 | log.Infof("Starting pipeline: %s", pipeline.Name())
24 | success, err := pipeline.Run()
25 |
26 | if err != nil {
27 | errorChannel <- PipelineError{
28 | Error: err,
29 | PipelineName: pipeline.Name(),
30 | }
31 | }
32 |
33 | if success != nil {
34 | successChan <- *success
35 | }
36 | } else {
37 | log.Debug("All pipelines complete")
38 | return
39 | }
40 | }
41 |
42 | }
43 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/data/assets.json:
--------------------------------------------------------------------------------
1 | {
2 | "custom.css": "custom.css",
3 | "js/auto-render.min.js": "js/auto-render-e6e57901eb.min.js",
4 | "js/clipboard-loader.min.js": "js/clipboard-loader-f0b5fbd5f6.min.js",
5 | "js/clipboard.min.js": "js/clipboard-27784b7376.min.js",
6 | "js/darkmode.min.js": "js/darkmode-ce906ea916.min.js",
7 | "js/flexsearch.min.js": "js/flexsearch-e54a90f706.min.js",
8 | "js/groupBy.min.js": "js/groupBy-174feb11c7.min.js",
9 | "js/katex-loader.min.js": "js/katex-loader-3cfedeea38.min.js",
10 | "js/katex.min.js": "js/katex-b7063e58c5.min.js",
11 | "js/mermaid-loader.min.js": "js/mermaid-loader-1bd1515cbf.min.js",
12 | "js/mermaid.min.js": "js/mermaid-1fc9ef3e82.min.js",
13 | "katex.min.css": "katex-38042a7abd.min.css",
14 | "main.min.css": "main-0c0de99286.min.css",
15 | "mobile.min.css": "mobile-c344439d04.min.css",
16 | "print.min.css": "print-f79fc3e5d7.min.css"
17 | }
--------------------------------------------------------------------------------
/docs/content/contributing/pipelines.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | id: pipelines
3 | title: Worker pipelines
4 | ---
5 |
6 | Commitsar uses pipelines in order to use as much CPU power as possible. These are based on number of CPU \* 2 (assuming 1 physical and 1 logical core available). In order to add a new pipeline
7 | you just need to build a pipeline that adheres to the types provided here: https://github.com/aevea/commitsar/blob/master/internal/dispatcher/pipeline.go and register it in the root_runner.
8 | Each pipeline returns either a success type or pushes errors into the error channel.
9 |
10 | At the end all of this is collected and the results are presented to the user.
11 |
12 | This will also be used to introduce an easy plugin system in the future.
13 |
14 | import Mermaid from "@theme/Mermaid";
15 |
16 | {{ .Title }}
6 |
7 |
8 |
14 |
15 |
21 | Read full post
22 |
23 | {{ end }}
24 |
5 | {{ template "toc-tree" dict "sect" .Page.Pages }}
6 |
7 | {{ end }}
8 |
9 |
10 | {{ define "toc-tree" }}
11 | -
12 | {{ range .sect.GroupBy "Weight" }}
13 | {{ range .ByTitle }}
14 | {{ if or (not .Params.GeekdocHidden) (not (default true .Params.GeekdocHiddenTocTree)) }}
15 |
- 16 | {{ if or .Content .Params.GeekdocFlatSection }} 17 | 18 | {{ partial "title" . }}{{ with .Params.GeekdocDescription }}: {{ . }}{{ else }}{{ end }} 19 | 20 | {{ else }} 21 | {{ partial "title" . }}{{ with .Params.GeekdocDescription }}: {{ . }}{{ end }} 22 | {{ end }} 23 | 24 | {{ $numberOfPages := (add (len .Pages) (len .Sections)) }} 25 | {{ if and (ne $numberOfPages 0) (not .Params.GeekdocFlatSection) }} 26 | {{ template "toc-tree" dict "sect" .Pages }} 27 | {{ end }} 28 | 29 | {{ end }} 30 | {{ end }} 31 | {{ end }} 32 |
17 |
18 |
19 |
20 | ![{{ $caption }}]()
22 |
23 |
24 | {{ with $caption -}}
25 | {{ . }}{{ with $source.Params.credits }} ({{ . | $.Page.RenderString }}){{ end }}
26 | {{- end }}
27 |
28 |
29 | {{ end }}
30 |
--------------------------------------------------------------------------------
/internal/commitpipeline/identify_same_branch.go:
--------------------------------------------------------------------------------
1 | package commitpipeline
2 |
3 | import (
4 | "fmt"
5 |
6 | history "github.com/aevea/git/v4"
7 | "github.com/apex/log"
8 | )
9 |
10 | // IdentifySameBranch breaks up the reference names and tries to identify if the branches are the same
11 | func IdentifySameBranch(branchA, branchB string, gitRepo *history.Git) (bool, error) {
12 | log.Debugf("Getting latest commit on branch '%s'...", branchA)
13 | commitBranchA, err := gitRepo.LatestCommitOnBranch(branchA)
14 |
15 | if err != nil {
16 | log.Errorf("Failed to get latest commit on branch '%s': %v", branchA, err)
17 | return false, fmt.Errorf("failed to get latest commit on branch '%s': %w", branchA, err)
18 | }
19 |
20 | log.Debugf("Branch '%s' latest commit hash: %s", branchA, commitBranchA.Hash)
21 |
22 | log.Debugf("Getting latest commit on upstream branch '%s'...", branchB)
23 | commitBranchB, err := gitRepo.LatestCommitOnBranch(branchB)
24 |
25 | if err != nil {
26 | log.Errorf("Failed to get latest commit on upstream branch '%s': %v", branchB, err)
27 | return false, fmt.Errorf("failed to get latest commit on upstream branch '%s' (ensure the branch exists and is fetched): %w", branchB, err)
28 | }
29 |
30 | log.Debugf("Branch '%s' latest commit hash: %s", branchB, commitBranchB.Hash)
31 |
32 | return commitBranchA.Hash == commitBranchB.Hash, nil
33 | }
34 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Commitsar
2 |
3 | [](https://goreportcard.com/report/github.com/aevea/commitsar)
4 | 
5 | 
6 | 
7 | [](https://conventionalcommits.org)
8 | [](https://repl.it/github/aevea/commitsar)
9 |
10 | Tool to make sure your commits are compliant with [conventional commits](https://www.conventionalcommits.org). It is aimed mainly at CIs to prevent branches with commits that don't comply. Usage as a pre-commit hook is also under consideration.
11 |
12 | ## Usage
13 |
14 | Please check [Documentation](https://commitsar.aevea.ee).
15 |
16 | ## Contributing
17 |
18 | Contributions are most welcome. Please check the [CONTRIBUTING](https://commitsar.aevea.ee/contributing/get_started) section of documentation.
19 |
20 | ## Sponsoring
21 |
22 | If you feel like showing even more support for this project you can sponsor it using the Sponsor button on GitHub. A little help goes a long way when it comes with OSS and it'll help support this project.
23 |
--------------------------------------------------------------------------------
/internal/prpipeline/title.go:
--------------------------------------------------------------------------------
1 | package prpipeline
2 |
3 | import (
4 | "context"
5 | "errors"
6 | "strings"
7 |
8 | history "github.com/aevea/git/v4"
9 | "github.com/apex/log"
10 | "github.com/google/go-github/v32/github"
11 | "github.com/spf13/viper"
12 | "golang.org/x/oauth2"
13 | )
14 |
15 | func getPRTitle(path string) (*string, error) {
16 | ghToken := viper.GetString("GITHUB_TOKEN")
17 |
18 | if !viper.IsSet("GITHUB_REPOSITORY") {
19 | return nil, errors.New("missing GITHUB_REPOSITORY env variable. Please provide one in owner/repository format")
20 | }
21 |
22 | split := strings.Split(viper.GetString("GITHUB_REPOSITORY"), "/")
23 |
24 | gitRepo, err := history.OpenGit(path)
25 |
26 | if err != nil {
27 | return nil, err
28 | }
29 |
30 | ctx := context.Background()
31 |
32 | ts := oauth2.StaticTokenSource(
33 | &oauth2.Token{AccessToken: ghToken},
34 | )
35 | tc := oauth2.NewClient(ctx, ts)
36 |
37 | client := github.NewClient(tc)
38 |
39 | currentCommit, err := gitRepo.CurrentCommit()
40 |
41 | if err != nil {
42 | return nil, err
43 | }
44 |
45 | prs, response, err := client.PullRequests.ListPullRequestsWithCommit(ctx, split[0], split[1], currentCommit.Hash.String(), nil)
46 |
47 | if err != nil {
48 | return nil, err
49 | }
50 |
51 | if len(prs) == 0 {
52 | log.Debugf("current commit %s", currentCommit.Hash.String())
53 | log.Debugf("%s", response)
54 |
55 | return nil, errors.New("no linked PullRequests found")
56 | }
57 |
58 | return prs[0].Title, nil
59 | }
60 |
--------------------------------------------------------------------------------
/.github/workflows/test.yml:
--------------------------------------------------------------------------------
1 | name: Test
2 |
3 | on: [pull_request]
4 |
5 | jobs:
6 | go-test:
7 | name: "Go Test"
8 | runs-on: ubuntu-latest
9 |
10 | steps:
11 | - name: Check out code into the Go module directory
12 | uses: actions/checkout@v6
13 | - name: Install mise
14 | uses: jdx/mise-action@v3
15 | - uses: actions/cache@v5
16 | with:
17 | path: ~/go/pkg/mod
18 | key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
19 | restore-keys: |
20 | ${{ runner.os }}-go-
21 | - name: Install tools
22 | run: mise install
23 | - name: Install mage
24 | run: mise exec -- go install github.com/magefile/mage@latest
25 | - name: Test
26 | run: mise exec -- mage test
27 |
28 | go-mod-tidy:
29 | name: "Go mod tidy"
30 | runs-on: ubuntu-latest
31 | steps:
32 | - name: Check out code into the Go module directory
33 | uses: actions/checkout@v6
34 | - name: Install mise
35 | uses: jdx/mise-action@v3
36 | - uses: actions/cache@v5
37 | with:
38 | path: ~/go/pkg/mod
39 | key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
40 | restore-keys: |
41 | ${{ runner.os }}-go-
42 | - name: Install tools
43 | run: mise install
44 | - name: Install mage
45 | run: mise exec -- go install github.com/magefile/mage@latest
46 | - name: Tidy check
47 | run: mise exec -- mage gomodtidy
48 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/404.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | {{ partial "head/meta" . }}
6 |
16 |
17 | {{ partial "site-header" (dict "Root" . "MenuEnabled" false) }}
18 |
19 |
20 |
34 |
35 | {{ partial "site-footer" . }}
36 |
37 |
38 |
39 |
40 |
41 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/partials/site-footer.html:
--------------------------------------------------------------------------------
1 |
30 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/_default/baseof.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | {{ partial "head/meta" . }}
6 |
18 |
19 |
20 | {{ $navEnabled := default true .Page.Params.GeekdocNav }}
21 | {{ partial "site-header" (dict "Root" . "MenuEnabled" $navEnabled) }}
22 |
23 |
24 | {{ if $navEnabled }}
25 |
28 | {{ end }}
29 |
30 |
35 |
36 | {{ partial "site-footer" . }}
37 |
38 |
39 | {{ partial "foot" . }}
40 |
41 |
42 |
--------------------------------------------------------------------------------
/internal/dispatcher/dispatcher_test.go:
--------------------------------------------------------------------------------
1 | package dispatcher
2 |
3 | import (
4 | "errors"
5 | "testing"
6 |
7 | "github.com/stretchr/testify/assert"
8 | )
9 |
10 | func TestDispatcher(t *testing.T) {
11 | dispatcher := New()
12 | dispatcher.maxWorkers = 1
13 |
14 | pipelines := []Pipeliner{TestPipeline{TestName: "pipeline1", TestFn: successPipeline}}
15 |
16 | results := dispatcher.RunPipelines(pipelines)
17 |
18 | assert.Equal(t, "pipeline1", results.SuccessfulPipelines[0].PipelineName)
19 | assert.Equal(t, "It succeeded", results.SuccessfulPipelines[0].Message)
20 |
21 | pipelines2 := []Pipeliner{TestPipeline{TestName: "pipeline1", TestFn: successPipeline}, TestPipeline{TestName: "pipeline2", TestFn: failPipeline}, TestPipeline{TestName: "pipeline3", TestFn: failPipeline}, TestPipeline{TestName: "pipeline4", TestFn: successPipeline}}
22 |
23 | results2 := dispatcher.RunPipelines(pipelines2)
24 |
25 | assert.Equal(t, 2, len(results2.SuccessfulPipelines))
26 | assert.Equal(t, 2, len(results2.Errors))
27 | }
28 |
29 | type TestPipeline struct {
30 | TestName string
31 | TestFn func() (*PipelineSuccess, error)
32 | }
33 |
34 | func (p TestPipeline) Name() string {
35 | return p.TestName
36 | }
37 |
38 | func (p TestPipeline) Run() (*PipelineSuccess, error) {
39 | return p.TestFn()
40 | }
41 |
42 | func successPipeline() (*PipelineSuccess, error) {
43 | return &PipelineSuccess{
44 | PipelineName: "pipeline1",
45 | Message: "It succeeded",
46 | }, nil
47 | }
48 |
49 | func failPipeline() (*PipelineSuccess, error) {
50 |
51 | return nil, errors.New("some error")
52 | }
53 |
--------------------------------------------------------------------------------
/docs/content/contributing/get_started.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: get_started
3 | title: Get started
4 | ---
5 |
6 | ## Requirements
7 |
8 | - [Go](https://golang.org/) (See pinned version in go.mod)
9 | - [git](https://git-scm.com/) (while git is not required to run commitsar, it is needed to set up tests)
10 |
11 | This project also uses [magefiles](https://magefile.org/). To get up and running please run: `go install github.com/magefile/mage`. These allow us to set up templates and cross-platform commands.
12 |
13 | ## Running tests
14 |
15 | Run `mage test`. This will git clone all git bundles and run tests in the entire repo. To run single tests use the VSCode functionality or provide the full path to `go test`.
16 |
17 | ## Git bundles
18 |
19 | In order to test commitsar against complicated real-life examples we use [git bundles](https://git-scm.com/docs/git-bundle). These can be `git cloned` like real repositories. They allow us to create real history and prevent edge cases that can happen when creating git history using shell (all commits have the same timestamp, for example).
20 |
21 | ### Creating a new bundle
22 |
23 | - create a new folder testdata/
24 | - cd into it
25 | - git initgitz
26 | - commit away
27 | - once ready run `git bundle create name_of_repo.bundle --all`
28 | - copy the bundle to testdata/
29 |
30 | All files outside of .bundle files are ignored in the testdata folder so you don't have to worry about cleanup.
31 |
32 | ## Commit style
33 |
34 | This project uses the [conventional commit style](https://www.conventionalcommits.org/en/v1.0.0/), it is also the default style commitsar uses.
35 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/partials/head/others.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 | {{ with .OutputFormats.Get "rss" -}}
19 | {{ printf `` .Rel .MediaType.Type .Permalink $.Site.Title | safeHTML }}
20 | {{ end -}}
21 |
22 | {{ if (default false $.Site.Params.GeekdocOverwriteHTMLBase) }}
23 |
31 | {{ template "main" . }}
32 | {{ partial "page-footer" . }}
33 |
34 | -
9 | {{ range .sect.GroupBy "Weight" }}
10 | {{ range .ByTitle }}
11 | {{ if not .Params.GeekdocHidden }}
12 |
13 | {{ $numberOfPages := (add (len .Pages) (len .Sections)) }}
14 | {{ $isParent := and (ne $numberOfPages 0) (not .Params.GeekdocFlatSection) }}
15 | {{ $isCurrent := eq $current . }}
16 | {{ $isAncestor := .IsAncestor $current }}
17 | {{ $id := substr (sha1 .Permalink) 0 8 }}
18 | {{ $doCollapse := and $isParent (or .Params.GeekdocCollapseSection (default false .Site.Params.GeekdocCollapseAllSections)) }}
19 |
20 |
- 21 | {{ if $doCollapse }} 22 | 23 | 38 | {{ end }} 39 | 40 | {{ if $isParent }} 41 | {{ template "tree-nav" dict "sect" .Pages "current" $current}} 42 | {{ end }} 43 | 44 | {{ end }} 45 | {{ end }} 46 | {{ end }} 47 |
-
10 | {{ range sort (default (seq 0) .sect) "weight" }}
11 | {{ $current.Scratch.Set "current" $current }}
12 | {{ $current.Scratch.Set "site" $site }}
13 |
14 |
- 15 | {{ $ref := default false .ref }} 16 | {{ if $ref}} 17 | {{ $site := $current.Scratch.Get "site" }} 18 | {{ $this := $site.GetPage .ref }} 19 | {{ $current := $current.Scratch.Get "current" }} 20 | {{ $icon := default false .icon }} 21 | {{ $numberOfPages := (add (len $this.Pages) (len $this.Sections)) }} 22 | {{ $isCurrent := eq $current $this }} 23 | {{ $isAncestor := $this.IsAncestor $current }} 24 | {{ $id := substr (sha1 $this.Permalink) 0 8 }} 25 | {{ $doCollapse := and (isset . "sub") (or $this.Params.GeekdocCollapseSection (default false .Site.Params.GeekdocCollapseAllSections)) }} 26 | 27 | {{ if $doCollapse }} 28 | 29 | 42 | {{ end }} 43 | {{ else }} 44 | {{ .name }} 45 | {{ end }} 46 | 47 | {{ with .sub }} 48 | {{ template "menu-file" dict "sect" . "current" ($current.Scratch.Get "current") "site" ($current.Scratch.Get "site") }} 49 | {{ end }} 50 | 51 | 52 | {{ end }} 53 |
3 | {{ if .MenuEnabled }}
4 |
14 | {{ end }}
15 |
16 |
17 | 
18 | {{ .Root.Site.Title }}
19 |
20 |
21 |
56 |
57 |