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

Integrate GolangCI-Lint #69

Closed
hanzei opened this issue Jul 28, 2020 · 2 comments · Fixed by #68
Closed

Integrate GolangCI-Lint #69

hanzei opened this issue Jul 28, 2020 · 2 comments · Fixed by #68
Assignees
Labels
Difficulty/2:Medium Medium ticket Help Wanted Community help wanted Tech/Go Type/Task A general task

Comments

@hanzei
Copy link
Collaborator

hanzei commented Jul 28, 2020

Mattermost is currently in the process of using golangci-lint as the default linter for all go projects. mattermost-community/mattermost-plugin-autolink#108 serves as an example of how the migration should look like:

  1. Copy .golangci.yml from https://github.com/mattermost/mattermost-plugin-autolink/ into this repository.
  2. Copy Makefile from https://github.com/mattermost/mattermost-plugin-autolink/ into this repository.
  3. Copy build/ from https://github.com/mattermost/mattermost-plugin-autolink/ into this repository.
  4. Run go mod tidy and make dist to ensure the build system works fine.
  5. Update linters-settings.goimports.local-prefixes to the go module path i.e. to github.com/mattermost/mattermost-plugin-aws-SNS.
  6. Run make golangci-lint and fix all issues that arise.

Fixing an linter issue is sometimes trivial but can also be quite complicated. There might be cases, where ignoring an issue using issues.exclude-rules is needed. If you don't know how to resolve an error, please reach out to @hanzei on the Mattermost Community Server or ask the question here.

@hanzei hanzei added Help Wanted Community help wanted Type/Task A general task Difficulty/2:Medium Medium ticket Tech/Go labels Jul 28, 2020
@hanzei hanzei linked a pull request Jul 28, 2020 that will close this issue
@jfrerich jfrerich self-assigned this Jul 28, 2020
@jfrerich
Copy link
Contributor

@hanzei, thanks for creating the more extensive and descriptive issue and linking the draft PR I had created. I am close to finishing that PR and will request you as reviewer.

This issue also encompasses #54. If you agree, we can close that issue.

@hanzei
Copy link
Collaborator Author

hanzei commented Jul 30, 2020

#68 will close both issues once it's merged. I would like to keep it open until the PR is merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Difficulty/2:Medium Medium ticket Help Wanted Community help wanted Tech/Go Type/Task A general task
Projects
None yet
2 participants