From a5ded8bc36469e44086df12ccdd0904e2b5f9e7e Mon Sep 17 00:00:00 2001 From: bytemare <3641580+bytemare@users.noreply.github.com> Date: Tue, 30 Jul 2024 11:43:47 +0200 Subject: [PATCH] update-ci Signed-off-by: bytemare <3641580+bytemare@users.noreply.github.com> --- .github/.golangci.yml | 203 ------------------ .github/CODE_OF_CONDUCT.md | 57 ----- .github/CONTRIBUTING.md | 34 --- .github/ISSUE_TEMPLATE/bug-report.md | 45 ---- .github/ISSUE_TEMPLATE/config.yml | 5 - .github/Makefile | 53 ----- .../pull_request_template.md | 34 --- .github/SECURITY.md | 10 - .github/licence-header.tmpl | 7 - .github/workflows/ci.yml | 84 -------- .github/workflows/codeql.yml | 39 ---- .github/workflows/scorecards.yml | 55 ----- 12 files changed, 626 deletions(-) delete mode 100644 .github/.golangci.yml delete mode 100644 .github/CODE_OF_CONDUCT.md delete mode 100644 .github/CONTRIBUTING.md delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md delete mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/Makefile delete mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md delete mode 100644 .github/SECURITY.md delete mode 100644 .github/licence-header.tmpl delete mode 100644 .github/workflows/ci.yml delete mode 100644 .github/workflows/codeql.yml delete mode 100644 .github/workflows/scorecards.yml diff --git a/.github/.golangci.yml b/.github/.golangci.yml deleted file mode 100644 index 03900c6..0000000 --- a/.github/.golangci.yml +++ /dev/null @@ -1,203 +0,0 @@ -linters: - disable-all: true - enable: - - asciicheck - - bidichk - - bodyclose - - containedctx - - contextcheck - - cyclop - - deadcode - #- depguard - - dogsled - - dupl - - durationcheck - - errcheck - - errname - - errorlint - - exportloopref - - forbidigo - - forcetypeassert - - funlen - - gocognit - - goconst - - gocritic - - gocyclo - - godot - - godox - - goerr113 - - gofmt - - gofumpt - - goheader - - goimports - - gomodguard - - gomoddirectives - - goprintffuncname - - gosec - - gosimple - - govet - - ifshort - - importas - - ineffassign - - lll - - makezero - #- maligned - - megacheck - - misspell - - nakedret - - nestif - - nilerr - - nilnil - - noctx - - nolintlint - - paralleltest - - prealloc - - predeclared - - revive - - rowserrcheck - - sqlclosecheck - - staticcheck - - structcheck - - stylecheck - #- tagliatelle - - tenv - - testpackage - - thelper - - tparallel - - typecheck - - unconvert - - unparam - - unused - - varcheck - #- varnamelen - - wastedassign - - whitespace - #- wrapcheck - - wsl - #- exhaustive - #- exhaustivestruct - #- gci - #- gochecknoglobals - #- gochecknoinits - #- gomnd - #- nlreturn - presets: - - bugs - - unused - fast: false - -linters-settings: - dupl: - threshold: 100 - errcheck: - check-type-assertions: true - check-blank: true - funlen: - lines: 100 - statements: 50 - gocognit: - min-complexity: 15 - goconst: - min-len: 2 - min-occurrences: 2 - gocritic: - enabled-tags: - - diagnostic - - experimental - - opinionated - - performance - - style - gocyclo: - min-complexity: 15 - godox: - keywords: - - NOTE - - OPTIMIZE - - HACK - - TODO - - todo - gofmt: - simplify: true - goimports: - local-prefixes: github.com/bytemare/frost - gomnd: - settings: - mnd: - checks: - - argument - - case - - condition - - operation - - return - - assign - govet: - check-shadowing: true - - # settings per analyzer - settings: - printf: # analyzer name, run `go tool vet help` to see all analyzers - funcs: # run `go tool vet help printf` to see available settings for `printf` analyzer - - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof - - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf - - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf - - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf - - # enable or disable analyzers by name - enable: - - atomicalign - disable-all: false - lll: - line-length: 120 - # tab width ('\t') in spaces. Default to 1. - tab-width: 4 - maligned: - suggest-new: true - misspell: - locale: US - prealloc: - simple: false - for-loops: true - unused: - check-exported: false - whitespace: - multi-if: false - multi-func: false - wsl: - # Allow declarations (var) to be cuddled. - allow-cuddle-declarations: true - # Allow trailing comments in ending of blocks - allow-trailing-comment: false - # Force newlines in end of case at this limit (0 = never). - force-case-trailing-whitespace: 0 - # Force cuddling of err checks with err var assignment - force-err-cuddling: true - # Allow leading comments to be separated with empty liens - allow-separated-leading-comment: false - -issues: - # List of regexps of issue texts to exclude, empty list by default. - # But independently from this option we use default exclude patterns, - # it can be disabled by `exclude-use-default: false`. To list all - # excluded by default patterns execute `golangci-lint run --help` - exclude: - - "should have a package comment, unless it's in another file for this package" - - exclude-rules: - - path: ./* - linters: - - exhaustive - - max-issues-per-linter: 0 - max-same-issues: 0 - - # Independently from option `exclude` we use default exclude patterns, - # it can be disabled by this option. To list all - # excluded by default patterns execute `golangci-lint run --help`. - # Default value for this option is true. - exclude-use-default: false - -run: - tests: false - -output: - format: github-actions \ No newline at end of file diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md deleted file mode 100644 index 9e07407..0000000 --- a/.github/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,57 +0,0 @@ - -# Contributor Covenant Code of Conduct [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](code_of_conduct.md) - -## Our Pledge - -We as members, contributors, and leaders pledge to make participation in our -community a harassment-free experience for everyone, regardless of age, body -size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, socio-economic status, -nationality, personal appearance, race, caste, color, religion, or sexual identity -and orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, -diverse, inclusive, and healthy community. - -## Our Standards - -Examples of behavior that contributes to a positive environment for our -community include: - -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, - and learning from the experience -* Focusing on what is best not just for us as individuals, but for the - overall community - -Examples of unacceptable behavior include: - -* The use of sexualized language or imagery, and sexual attention or - advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email - address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.0, available at -[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. - -Community Impact Guidelines were inspired by -[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. - -For answers to common questions about this code of conduct, see the FAQ at -[https://www.contributor-covenant.org/faq][FAQ]. Translations are available -at [https://www.contributor-covenant.org/translations][translations]. - -[homepage]: https://www.contributor-covenant.org -[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html -[Mozilla CoC]: https://github.com/mozilla/diversity -[FAQ]: https://www.contributor-covenant.org/faq -[translations]: https://www.contributor-covenant.org/translations diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md deleted file mode 100644 index 8e40d2f..0000000 --- a/.github/CONTRIBUTING.md +++ /dev/null @@ -1,34 +0,0 @@ -# How to contribute - -### Did you find a bug? 🐞 - -* 🔎 Please ensure your findings have not already been reported by searching on the project repository under [Issues](https://github.com/bytemare/frost). -* If you think your findings can be complementary to an existing issue, don't hesitate to join the conversation 😃☕ -* If there's no issue addressing the problem, [open a new one](https://github.com/bytemare/frost/issues/new). Please be clear in the title and description, and add relevant information. Bonus points if you provide a **code sample** and everything needed to reproduce the issue when expected behaviour is not occurring. -* If possible, use the relevant issue templates. - -### Do you have a fix? - -🎉 That's awesome! Pull requests are welcome! - -* Please [open an issue](https://github.com/bytemare/frost) beforehand, so we can discuss this. -* Fork this repo from `main`, and ensure your fork is up-to-date with it when submitting the PR. -* If your changes impact the documentation, please update it accordingly. -* If you added code that impact tests, please add tests with relevant coverage and test cases. Bonus points for fuzzing. -* 🛠️ Make sure the test suite passes. - -If your changes might have an impact on performance, please benchmark your code and measure the impact, share the results and the tests that lead to these results. - -Please note that changes that are purely cosmetic and do not add anything substantial to the stability, functionality, or testability of the project may not be accepted. - -### Coding Convention - -This project tries to be as Go idiomatic as possible. Conventions from [Effective Go](https://golang.org/doc/effective_go) apply here. Tests use a very opinionated linting configuration that you should use before committing to your changes. - -### Licence - -By contributing to this project, you agree that your contributions will be licensed under the project's [License](https://github.com/bytemare/template/blob/main/LICENSE). - -All contributions (including pull requests) must agree to the [Developer Certificate of Origin (DCO) version 1.1](http://developercertificate.org). It states that the contributor has the right to submit the patch for inclusion into the project. Simply submitting a contribution implies this agreement, however, please include the "Signed-off-by" git tag in every commit (this tag is a conventional way to confirm that you agree to the DCO). - -Thanks! :heart: \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 915c281..0000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -name: "\U0001F41E Bug report" -about: Create a report to help us improve -title: "[BUG]" -labels: bug -assignees: bytemare - ---- - - - -### Describe the bug -A clear and concise description of what the bug is. - -### Your setup - -**What version/commit of the project are you using?** - -**What version of go are you using?** -
-$ go version
-
-
- -**What does the go environment look like?** -
go env Output
-$ go env
-
-
- -**If relevant, what parameters or arguments are you using?** - -### Reproducing - -**What did you do?** -Steps to reproduce the behavior: -1. '....' - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index f84c297..0000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1,5 +0,0 @@ -blank_issues_enabled: false -contact_links: -- name: Questions, feature requests, and more 💬 - url: https://github.com/bytemare/frost/discussions - about: Do you need help? Did you make something with frost? Do you have an idea? Tell us about it! \ No newline at end of file diff --git a/.github/Makefile b/.github/Makefile deleted file mode 100644 index 9829570..0000000 --- a/.github/Makefile +++ /dev/null @@ -1,53 +0,0 @@ -GH_ACTIONS = workflows - -.PHONY: update -update: - @cd ../ - @echo "Updating dependencies..." - @go mod tidy - @echo "Updating Github Actions pins..." - @$(foreach file, $(wildcard workflows/*.yml), pin-github-action $(file);) - -.PHONY: update-linters -update-linters: - @echo "Updating linters..." - @go install mvdan.cc/gofumpt@latest - @go install github.com/daixiang0/gci@latest - @go install github.com/segmentio/golines@latest - @go install golang.org/x/tools/go/analysis/passes/fieldalignment/cmd/fieldalignment@latest - @curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin - -.PHONY: fmt -fmt: - @echo "Formatting ..." - @go mod tidy - @go fmt ../... - @golines -m 120 -t 4 -w ../ - @gofumpt -w -extra ../ - @gci write -s Standard -s Default -s "Prefix($(shell go list -m))" ../ - @fieldalignment -fix ../... - -.PHONY: license -license: - @echo "Checking License headers ..." - @if addlicense -check -v -skip yml -skip yaml -f licence-header.tmpl ../*; then echo "License headers OK"; else return 1; fi; - -.PHONY: lint -lint: fmt license - @echo "Linting ..." - @if golangci-lint run --config=.golangci.yml ../...; then echo "Linting OK"; else return 1; fi; - -.PHONY: test -test: - @echo "Running all tests ..." - @go test -v -vet=all ../tests - -.PHONY: vectors -vectors: - @echo "Testing vectors ..." - @go test -v ../tests/vectors_test.go - -.PHONY: cover -cover: - @echo "Testing with coverage ..." - @go test -v -race -covermode=atomic -coverpkg=../... -coverprofile=../coverage.out ../tests diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md deleted file mode 100644 index 0c4ba8a..0000000 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ /dev/null @@ -1,34 +0,0 @@ - - -### Description - - -### Related Issue - - - - - -### Motivation and Context - - -### How Has This Been Tested? - - - - -### Types of changes - -- [ ] Bug fix (non-breaking change which fixes an issue) -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to change) - -### Checklist: - - -- [ ] My code follows the code style of this project. -- [ ] My change requires a change to the documentation. -- [ ] I have updated the documentation accordingly. -- [ ] I have read the **CONTRIBUTING** document. -- [ ] I have added tests to cover my changes. -- [ ] All new and existing tests passed. diff --git a/.github/SECURITY.md b/.github/SECURITY.md deleted file mode 100644 index ac9af76..0000000 --- a/.github/SECURITY.md +++ /dev/null @@ -1,10 +0,0 @@ -# Security Policy - -## Supported Versions - -Only the latest version will be benefit from security fixes. Maintainers of projects using this package are invited to update their dependency. - -## Reporting a Vulnerability - -Vulnerabilities can be reported through GitHub issues, here: https://github.com/bytemare/frost/security/advisories -If the issue is sensitive enough that the reporter thinks the discussion needs more confidentiality, we can discuss options there (e.g. On a Security Advisory or per e-mail). diff --git a/.github/licence-header.tmpl b/.github/licence-header.tmpl deleted file mode 100644 index 12c483f..0000000 --- a/.github/licence-header.tmpl +++ /dev/null @@ -1,7 +0,0 @@ -SPDX-License-Identifier: MIT - -Copyright (C) 2023 Daniel Bourdrez. All Rights Reserved. - -This source code is licensed under the MIT license found in the -LICENSE file in the root directory of this source tree or at -https://spdx.org/licenses/MIT.html \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml deleted file mode 100644 index 068bd26..0000000 --- a/.github/workflows/ci.yml +++ /dev/null @@ -1,84 +0,0 @@ -name: FROST -on: - pull_request: - branches: - - main - -permissions: - contents: read - -jobs: - lint: - name: Lint - runs-on: ubuntu-latest - steps: - - name: Checkout repo - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # pin@master - with: - fetch-depth: 0 - - name: Setup Go - uses: actions/setup-go@6edd4406fa81c3da01a34fa6f6343087c207a568 # pin@master - with: - go-version-file: ./go.mod - - # Lint - - name: Linting - uses: golangci/golangci-lint-action@5c56cd6c9dc07901af25baab6f2b0d9f3b7c3018 # pin@master - with: - version: latest - args: --config=./.github/.golangci.yml ./... - only-new-issues: true - - test: - name: Test on ${{ matrix.go }} - runs-on: ubuntu-latest - strategy: - fail-fast: false - matrix: - go: [ '1.21' ] - steps: - - name: Checkout repo - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # pin@master - with: - fetch-depth: 0 - - name: Setup Go - uses: actions/setup-go@6edd4406fa81c3da01a34fa6f6343087c207a568 # pin@master - with: - go-version: ${{ matrix.go }} - - # Test - - name: Run Tests - run: cd .github && make test - - analyze: - name: Analyze - runs-on: ubuntu-latest - steps: - - name: Checkout repo - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # pin@master - with: - fetch-depth: 0 - - name: Setup Go - uses: actions/setup-go@6edd4406fa81c3da01a34fa6f6343087c207a568 # pin@master - with: - go-version-file: ./go.mod - - # Coverage - - name: Run coverage - run: cd .github && make cover - - # Codecov - - name: Codecov - uses: codecov/codecov-action@29386c70ef20e286228c72b668a06fd0e8399192 # pin@master - with: - file: .github/coverage.out - - # Sonar - - name: SonarCloud Scan - uses: SonarSource/sonarcloud-github-action@5ee47de3c96f0c1c51b09d2ff1fec0cfeefcf67c # pin@master - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} - with: - args: > - -Dsonar.projectKey=bytemare_frost -Dsonar.organization=bytemare-github -Dsonar.sources=. -Dsonar.go.coverage.reportPaths=.github/coverage.out -Dsonar.test.exclusions=examples_test.go,tests/** -Dsonar.tests=tests/ -Dsonar.verbose=true diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml deleted file mode 100644 index 1efceab..0000000 --- a/.github/workflows/codeql.yml +++ /dev/null @@ -1,39 +0,0 @@ -name: "CodeQL" - -on: - pull_request: - branches: - - main - schedule: - - cron: '31 10 * * 0' - -permissions: - contents: read - -jobs: - codeql: - name: CodeQL - runs-on: ubuntu-latest - permissions: - actions: read - contents: read - security-events: write - - strategy: - fail-fast: false - - steps: - - name: Checkout repository - uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # pin@master - - # Initializes the CodeQL tools for scanning. - - name: Initialize CodeQL - uses: github/codeql-action/init@231aa2c8a89117b126725a0e11897209b7118144 # pin@master - with: - languages: go - - - name: Autobuild - uses: github/codeql-action/autobuild@231aa2c8a89117b126725a0e11897209b7118144 # pin@master - - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@231aa2c8a89117b126725a0e11897209b7118144 # pin@master diff --git a/.github/workflows/scorecards.yml b/.github/workflows/scorecards.yml deleted file mode 100644 index 239e26e..0000000 --- a/.github/workflows/scorecards.yml +++ /dev/null @@ -1,55 +0,0 @@ -name: Scorecards supply-chain security -on: - # Only the default branch is supported. - branch_protection_rule: - schedule: - - cron: '44 9 * * 0' - push: - branches: [ main ] - -# Declare default permissions as read only. -permissions: read-all - -jobs: - analysis: - name: Scorecards analysis - runs-on: ubuntu-latest - permissions: - # Needed to upload the results to code-scanning dashboard. - security-events: write - actions: read - contents: read - - steps: - - name: "Checkout code" - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 # pin@master - with: - persist-credentials: false - - - name: "Run analysis" - uses: ossf/scorecard-action@c1aec4ac820532bab364f02a81873c555a0ba3a1 # pin@master - with: - results_file: results.sarif - results_format: sarif - # Read-only PAT token. To create it, - # follow the steps in https://github.com/ossf/scorecard-action#pat-token-creation. - repo_token: ${{ secrets.SCORECARD_TOKEN }} - # Publish the results to enable scorecard badges. For more details, see - # https://github.com/ossf/scorecard-action#publishing-results. - # For private repositories, `publish_results` will automatically be set to `false`, - # regardless of the value entered here. - publish_results: true - - # Upload the results as artifacts (optional). - - name: "Upload artifact" - uses: actions/upload-artifact@82c141cc518b40d92cc801eee768e7aafc9c2fa2 # pin@master - with: - name: SARIF file - path: results.sarif - retention-days: 5 - - # Upload the results to GitHub's code scanning dashboard. - - name: "Upload to code-scanning" - uses: github/codeql-action/upload-sarif@5f532563584d71fdef14ee64d17bafb34f751ce5 # pin@master - with: - sarif_file: results.sarif