Commit Graph

29 Commits

Author SHA1 Message Date
Spencer Schrock
4c6d0e53a3
📖 revert PAT scope change and document Go resources (#4003)
* undo pat scope doc change

Signed-off-by: Spencer Schrock <sschrock@google.com>

* add Go resources

some contributors may be unfamiliar with the language

Signed-off-by: Spencer Schrock <sschrock@google.com>

---------

Signed-off-by: Spencer Schrock <sschrock@google.com>
2024-04-08 08:37:04 -07:00
Spencer Schrock
aeaee6099e
📖 Review and update CONTRIBUTING.md (#4002)
* feature dco requirement more prominently

Signed-off-by: Spencer Schrock <sschrock@google.com>

* recommend merge commits to sync PR

Signed-off-by: Spencer Schrock <sschrock@google.com>

* fix make target table

Signed-off-by: Spencer Schrock <sschrock@google.com>

* remove references to old Go environment variables

GO111MODULE is no longer used as of Go 1.17.
GOPATH is still used for other purposes, but not in 'development mode'.
https://go.dev/wiki/GOPATH

Signed-off-by: Spencer Schrock <sschrock@google.com>

* misc minor clarifications

Signed-off-by: Spencer Schrock <sschrock@google.com>

* remove reference to errors from CONTRIBUTORS.md

I don't think this is one of the top things we should be displaying to someone

Signed-off-by: Spencer Schrock <sschrock@google.com>

* mention make in environment

Signed-off-by: Spencer Schrock <sschrock@google.com>

* no scopes needed for PATs

Signed-off-by: Spencer Schrock <sschrock@google.com>

* highlight other scorecard options

Signed-off-by: Spencer Schrock <sschrock@google.com>

* allow shell codeblocks to be pasted into a shell

the comment style was wrong and the $ was interpretted as a command.

Signed-off-by: Spencer Schrock <sschrock@google.com>

---------

Signed-off-by: Spencer Schrock <sschrock@google.com>
2024-04-04 12:52:11 -07:00
AdamKorcz
1a1d9b175c
📖 Add documentation about probes and contributing (#3762)
* 📖 Add documentation about probes and contributing

Signed-off-by: Adam Korczynski <adam@adalogics.com>

* change 'subdirectory' to 'directory'

Signed-off-by: Adam Korczynski <adam@adalogics.com>

* fix 'golangci' typo

Signed-off-by: Adam Korczynski <adam@adalogics.com>

* Added 'make fix-linter' to Makefile

Signed-off-by: Adam Korczynski <adam@adalogics.com>

* Move commands to their own table

Signed-off-by: Adam Korczynski <adam@adalogics.com>

* change 'problem' to 'supply-chain security risk'

Signed-off-by: Adam Korczynski <adam@adalogics.com>

* Add sentence about what a finding is

Signed-off-by: Adam Korczynski <adam@adalogics.com>

* remove sentence about running make rule locally

Signed-off-by: Adam Korczynski <adam@adalogics.com>

* change 'supply-chain security risk' to 'heuristic'

Signed-off-by: Adam Korczynski <adam@adalogics.com>

* Modify text on where to set remediation data

Signed-off-by: Adam Korczynski <adam@adalogics.com>

* Add example

Signed-off-by: Adam Korczynski <adam@adalogics.com>

* add line about discussing changes to the score in a GitHub issue

Signed-off-by: Adam Korczynski <adam@adalogics.com>

---------

Signed-off-by: Adam Korczynski <adam@adalogics.com>
2024-01-23 11:32:59 -08:00
Spencer Schrock
ee4e83a318
🌱 Enforce make add-projects for GitHub and GitLab repos (#3780)
* fail if add-projects not run

Signed-off-by: Spencer Schrock <sschrock@google.com>

* add gitlab file to add-projects

Signed-off-by: Spencer Schrock <sschrock@google.com>

* order gitlab projects with make add-projects

Signed-off-by: Spencer Schrock <sschrock@google.com>

* simplify workflow job

this binary doesn't need the build protos

Signed-off-by: Spencer Schrock <sschrock@google.com>

---------

Signed-off-by: Spencer Schrock <sschrock@google.com>
2024-01-19 14:11:19 -08:00
Spencer Schrock
a4ee3147a6
🌱 bump project minimum Go version to go1.21 (#3661)
* upgrade go.mod to 1.21

Signed-off-by: Spencer Schrock <sschrock@google.com>

* use slices from stdlib

Signed-off-by: Spencer Schrock <sschrock@google.com>

* use max/min builtins

Signed-off-by: Spencer Schrock <sschrock@google.com>

* multierrors

possibly spin this off into its own PR

Signed-off-by: Spencer Schrock <sschrock@google.com>

* dont call rand.Seed

As of Go 1.20, the generator is seeded randomly at startup.
https://pkg.go.dev/math/rand#Seed

Signed-off-by: Spencer Schrock <sschrock@google.com>

* update minimum Go version in documentation

Signed-off-by: Spencer Schrock <sschrock@google.com>

---------

Signed-off-by: Spencer Schrock <sschrock@google.com>
2023-11-13 15:12:29 -08:00
Spencer Schrock
5ec66fa906
🌱 Migrate to go 1.21 (#3387)
* Bump dockerfiles to 1.21
* Go minimum version should match our go.mod
* Bump GitHub action go version to 1.21 and ensure all workflows use env variable.

---------

Signed-off-by: Spencer Schrock <sschrock@google.com>
2023-08-14 14:32:42 -04:00
Gabriela Gutierrez
0f33c370e5
📖 Update docs on how to run and debug locally (#2587)
* Change docs on how to run and debug locally

Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com>

* Remove docs section on debug Go lang

Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com>

Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com>
2023-02-01 04:06:46 +00:00
Arnaud J Le Hors
c3f4e31c28
📖 Use scorecard (singular) consistently (#2428)
* Use scorecard (singular) consistently
* Use OpenSSF instead of Security in name and add FAQ entry
2022-12-01 15:06:12 +05:30
Dave Banerjee
d7c23c9433
📖 Patch fix: updated makefile to include unit-test and unit-test-attestor and cont… (#2366)
* updated makefile to include unit-test and unit-test-attestor and contributing doc to include e2e-pat

Signed-off-by: Dave Banerjee <dave.banerjee@ibm.com>

* updated docs

Signed-off-by: Dave Banerjee <dave.banerjee@ibm.com>

Signed-off-by: Dave Banerjee <dave.banerjee@ibm.com>
Co-authored-by: Dave Banerjee <Dave.Banerjee@ibm.com>
2022-10-20 22:28:55 +00:00
Arnaud J Le Hors
2c34a46503
Fix cron related documentation (#1986)
Fix link to projects.csv in README.md
Remove out of date info on daily cron job from CONTRIBUTING.md and fix
various links.

Signed-off-by: Arnaud J Le Hors <lehors@us.ibm.com>

Co-authored-by: Azeem Shaikh <azeemshaikh38@gmail.com>
2022-06-07 20:12:28 +02:00
Martijn Pieters
88aa0e8159 📖 Add make install to Environment Setup
Fixes #1588
2022-02-03 10:39:37 -06:00
Arnout Engelen
24842de010 📖 remove inaccurate claim about github rendering emoji
GitHub renders `:xyz:` aliases in PR titles just fine nowadays.
2022-02-02 09:15:27 -06:00
Romain Dauby
c26bea648d
📖 Minor fixes to markdown links (#1141)
* Minor fixes to markdown links

* Minor fix generate docs
2021-10-19 12:14:11 -07:00
David A. Wheeler
b6cd4cfe9f
Fix CONTRIBUTING.md for doc updates 📖 (#1007)
The `CONTRIBUTING.md` documentation was obsolete when discussing
documentation updates. It gave the wrong location for `checks.yaml`,
wrong command to update `checks.md`, and failed to note that some
documentation wasn't in `checks.yaml`.

This commit updates the docs-about-docs so it's hopefully
correct again :-).

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>

Co-authored-by: Abhishek Arya <inferno@chromium.org>
2021-09-13 20:40:56 +00:00
flying-cow
1434977ac0 :sparkling: Upgraded to go 1.17 2021-09-01 18:31:44 -04:00
laurentsimon
ab4bb60c9c
[migration to score] 1: create errors and new functions (#712)
* details-1

* comment

* doc

* nits

* typo

* commments

* nit

* linter
2021-07-20 11:36:35 -07:00
Chris McGehee
50f7ed8519
🌱Fix lint issues: gochecknoinits linter (#485)
* Fix lint issues: gochecknoinits linter

* Fix lint issues: gochecknoinits linter
2021-05-22 13:19:52 -04:00
naveen
670e1980d5 📖 Updated instruction for check documentation
Included docs in CONTRIBUTING.md for updating docs for checks.
2021-05-14 16:22:58 -05:00
Azeem Shaikh
80203a8351
Move k8s into cron folder. (#410)
Co-authored-by: Azeem Shaikh <azeems@google.com>
2021-05-07 05:08:33 -07:00
Chris McGehee
06993b72ce
🐛 Fix linting issues (1 of n) (#348)
* Fix lint issues: whitespace linter

* Fix lint issues: wrapcheck linter

* Fix lint issues: errcheck linter

* Fix lint issues: paralleltest linter

* Fix lint issues: gocritic linter
Most changes from this commit are from passing checker.CheckResult by reference and not by value. gocritic identified that as a huge parameter.
gocritic also prefers regexp.MustCompile over Compile when the pattern is a const
2021-04-19 12:18:34 -07:00
naveen
52e742cce9 📖 Instructions on PR process
* Included instructions in the PR process.
2021-03-21 11:11:30 -04:00
naveen
c62e667f7c Docs - Included instructions for deploying cron
Included instructions for deployment of the k8s cron job for the daily
score.
2021-03-16 10:15:14 -04:00
naveen
27ec7fff8d Docs - Updated the docs for cron
Included a section within the CONTRIBUTING.md about the dailyscore and
cron job.
2021-03-15 12:38:58 -04:00
Naveen
b4c2e4fd13
feat - migrate to go 1.16 (#233)
Upgrade to go version 1.16
2021-03-03 18:56:29 +00:00
Naveen
66af8d8235
Doc - Update contributing to reflect changes (#208) 2021-02-21 16:18:03 -08:00
naveen
f57080098c Doc - Updates to README and CONTRIBUTING 2021-02-16 17:00:36 -05:00
naveen
c4c99cd676 feature - Included the e2e into the PR workflows
Validated the presence of the GITHU_AUTH_TOKEN variable presence before running the e2e.

Update the contributing doc with scopes of the personal access token.

Updated the workflow to include the e2e tests.
2021-01-13 13:04:22 -05:00
naveen
c5c51b9977 feature - Update the CONTRIBUTING guidelines
* Updated the contributing guidelines with Environment Setup,
Contributing steps, How to build scorecard locally, What to do before
submitting a pull request and Where the CI Tests are configured.

Signed-off-by: naveen <172697+naveensrinivasan@users.noreply.github.com>
2021-01-04 12:13:07 -05:00
Abhishek Arya
81eab9d2d8
Add license header and code of conduct files. (#34)
* Add license header and code of conduct files.

* Fill missing field.
2020-10-26 15:22:13 -05:00