clean CI jobs, Makefile and go.mod/Dockerfile #350
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The hack/check-format.sh script is not used anywhere (and there is a `make fmtcheck` target that accomplishes the same thing). So, removing that. Also remove all the duplicative (and out-of-date) documentation from the `doc.go` file for two reasons: 1) pkg.go.dev now includes the README in its entirety and therefore there is not a need to duplicate the information from the README into a `doc.go` file. 2) Having two places for examples and docs just meant the information in `doc.go` quickly got out of date. Signed-off-by: Jay Pipes <jaypipes@gmail.com>
1941ff9 to
e9a0cea
Compare
Updates to Go 1.19 in go.mod to get us to a more modern Go release. Similarly changes the Dockerfile that builds the `ghwc` binary to use Go 1.19 and use a hashed version of the Alpine base image to address security best practices. Finally, removes the outdated and unnecessary Make targets and unnecessarily complicated calls to find Go packages. These targets and fancy code was left over from before Go modules and when we were using `dep` and vendoring things. Adds a `.github/workflows/fmtcheck.yml` that follows GH actions security best practices and separates the fmtcheck stuff from the other tests in the main `.github.com/workflows/go.yml`. Signed-off-by: Jay Pipes <jaypipes@gmail.com>
pulls out the golangci-lint job from the main go.yml Github Action and into its own workflow that follows security best practices like ensuring read-only permissions and using SHA-specific Action releases. Signed-off-by: Jay Pipes <jaypipes@gmail.com>
Updates the GH Action workflow for unit testing with security best practices, including reduce permissions, the step security action hardener, and using SHA-specific Action releases. Signed-off-by: Jay Pipes <jaypipes@gmail.com>
|
@ffromani this PR does a bunch of cleanup of our CI jobs (GH Action runners) in preparation for the v1 milestone. Most of the cleanup was around hardening of the workflows in accordance with security best practices from step-security. Feel free to review! :) |
ffromani
reviewed
Jul 21, 2023
Comment on lines
+9
to
+22
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| fmtcheck: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: harden runner | ||
| uses: step-security/harden-runner@55d479fb1c5bcad5a4f9099a5d9f37c8857b2845 # v2.4.1 | ||
| with: | ||
| egress-policy: block | ||
| disable-sudo: true | ||
| allowed-endpoints: > | ||
| github.com:443 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
harden and refactor GH action for unit tests
separate linter job in Github Actions
cleanup Makefile, Dockerfile, go.mod
remove old hack/check-format.sh and doc.go content