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

Create a lint workflow for copyright checking #17378

Closed
wants to merge 4 commits into from

Conversation

dekimsey
Copy link
Collaborator

@dekimsey dekimsey commented Jun 1, 2023

This change introduces a lint workflow that verifies files have the required copyright headers. This allows us to be more proactive regarding copyright changes before the bot comes around and asks for changes.

I've created this as a generic workflow "Lint" so that we have a place to possibly surface make check tests to our contributors.

Discovered during #17103

Since we are adding a lint to an existing repository, I've gone ahead and applied the fix to failing files. Attached is an example of the copyright lint action failing:
image

As a future improvement, perhaps we can migrate the `make check` tests here to run
them in parallel and also allow for surfacing annotations from linting.
@lgfa29
Copy link
Contributor

lgfa29 commented Jun 2, 2023

Thanks @dekimsey! Detecting these missing headers early is a good improvement 😄

Do you know which version of the CLI is used and if it would it include this fix? hashicorp/copywrite#59

@lgfa29 lgfa29 self-assigned this Jun 2, 2023
runs-on: ubuntu-latest
steps:
- name: Setup Copywrite
uses: hashicorp/setup-copywrite@867a1a2a064a0626db322392806428f7dc59cb3e # v1.1.2
Copy link
Member

Choose a reason for hiding this comment

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

I thought we didn't need to pin hashicorp/* namespaced actions? It would be nice to be able to automatically pick up updates to the action without having to deal with a dependabot update

@tgross
Copy link
Member

tgross commented Jul 12, 2023

Superceded by #17889

@tgross tgross closed this Jul 12, 2023
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.

3 participants