Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GH: Add basic GH Actions workflow for code quality #6

Merged
merged 7 commits into from
Feb 8, 2024

Conversation

briancain
Copy link
Member

Fixes #5

This repo will probably want to be outfitted with hcp-checks, which
includes a linter.
@briancain
Copy link
Member Author

I was going to include the linter, but I imagine this repo should be outfitted with hcp-checks, which comes with a linter job for GH actions?

@evanphx
Copy link
Contributor

evanphx commented Feb 8, 2024

I'm going to let @dadgar weigh in before we merge this.

@dadgar
Copy link
Collaborator

dadgar commented Feb 8, 2024

@briancain lets not use hcp-checks since that is built for internal services

Comment on lines 19 to 26
# Disabling linter for now. Will enable when project is finished, so
# all of the errors can be fixed in a single pass
#- name: golangci-lint
# uses: golangci/golangci-lint-action@v3
# with:
# # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
# version: latest
# args: --build-tags="$GOTAGS" --concurrency 2 --timeout 10m
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a make target for the linter we can use: https://github.com/hashicorp/hcp/blob/main/Makefile#L15

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep yep, I had added it originally, but the GH runner doesn't have the go tool installed to use that. There should be a way to add it

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opted to go for the official GH action instead, much easier! Also there are linter errors on this repo so it rightfully is failing right now.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice this works! I assume this was the plan but can we delete this comment block then

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep! Just pushed a commit to remove this comment block ✨

Comment on lines 19 to 26
# Disabling linter for now. Will enable when project is finished, so
# all of the errors can be fixed in a single pass
#- name: golangci-lint
# uses: golangci/golangci-lint-action@v3
# with:
# # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
# version: latest
# args: --build-tags="$GOTAGS" --concurrency 2 --timeout 10m
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice this works! I assume this was the plan but can we delete this comment block then

@briancain briancain merged commit 5cdd5da into main Feb 8, 2024
2 checks passed
@briancain briancain deleted the gh/setup-basic-go-worfklows-for-a-repo branch February 8, 2024 22:20
teresamychu pushed a commit that referenced this pull request Feb 22, 2024
…a-repo

GH: Add basic GH Actions workflow for code quality
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Setup Github actions for running unit tests and Golang linters
3 participants