8000 fix: license headers incorrectly interpreted as package documentation by jhoward-lm · Pull Request #157 · bomctl/bomctl · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix: license headers incorrectly interpreted as package documentation #157

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Sep 16, 2024
Merged

fix: license headers incorrectly interpreted as package documentation #157

merged 3 commits into from
Sep 16, 2024

Conversation

jhoward-lm
Copy link
Contributor
@jhoward-lm jhoward-lm commented Sep 15, 2024 •
edited
Loading

Description

This PR fixes #156.

The primary change is a new shell script that checks each .go file's header, ensuring a blank line is present before each package declaration and the file name is correct.

Go file changes:

  • Extend dashes of header separator
  • Fix file names where incorrect
  • Add blank line before each package declaration
  • No logic changes

Type of change

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

  • Update .taskfiles/lint.yml and Makefile
  • Headers checked in workflow

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

@jhoward-lm
fix: license headers incorrectly interpreted as package documentation
06c459a 
Signed-off-by: Jonathan Howard <jonathan.w.howard@lmco.com>
@jhoward-lm
ci: run check-go-headers.sh in workflow
8a7879a 
Signed-off-by: Jonathan Howard <jonathan.w.howard@lmco.com>
@jhoward-lm jhoward-lm added bug Something isn't working documentation Improvements or additions to documentation labels Sep 15, 2024
@jhoward-lm jhoward-lm self-assigned this Sep 15, 2024
@jhoward-lm jhoward-lm requested a review from a team as a code owner September 15, 2024 20:47
@jhoward-lm jhoward-lm linked an issue Sep 15, 2024 that may be closed by this pull request
SPDX headers incorrectly interpreted as package documentation #156
Closed
@jhoward-lm
fix: make script executable
8536309 
Signed-off-by: Jonathan Howard <jonathan.w.howard@lmco.com>
@jhoward-lm jhoward-lm mentioned this pull request Sep 16, 2024
Merged
8000 9 tasks
@jhoward-lm jhoward-lm merged commit 9eadeed into main Sep 16, 2024
10 checks passed
@jhoward-lm jhoward-lm deleted the 156-package-documentation-fix branch September 16, 2024 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ashearin ashearin ashearin approved these changes

@idunbarh idunbarh idunbarh approved these changes

@eddiezane eddiezane Awaiting requested review from eddiezane

@lmphil lmphil Awaiting requested review from lmphil

@mfrystacky mfrystacky Awaiting requested review from mfrystacky

Assignees

@jhoward-lm jhoward-lm

Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
bomctl
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

SPDX headers incorrectly interpreted as package documentation
3 participants
@jhoward-lm @ashearin @idunbarh
0