Skip to content

chore: OSS compliance — NOTICE, CodeQL, .gitignore#75

Merged
mayankpande88 merged 2 commits into
mainfrom
chore/oss-compliance
May 12, 2026
Merged

chore: OSS compliance — NOTICE, CodeQL, .gitignore#75
mayankpande88 merged 2 commits into
mainfrom
chore/oss-compliance

Conversation

@mayankpande88
Copy link
Copy Markdown
Contributor

Summary

Three small OSS-readiness items in one PR.

NOTICE file

Apache 2.0 §4(d) asks downstream forks to preserve attribution. Neither upstream (yahoo/kubectl-flame, josepdcs/kubectl-prof) shipped a NOTICE file, and the josepdcs fork stripped the //: Copyright Verizon Media per-file headers that the original Yahoo repo had. This adds a top-level NOTICE that:

  • Credits the fork chain explicitly (Nudgebee → josepdcs → Yahoo / Verizon Media)
  • Lists the major bundled third-party tools and their licenses (async-profiler, py-spy, rbspy, austin, FlameGraph, BCC)

We don't retroactively restore per-file headers — the fork tree is mixed (many files were added by josepdcs and have no Verizon ancestry), so per-file work would be incomplete and noisy. NOTICE-level attribution is the standard approach for fork chains.

.gitignore

Adds .DS_Store, .vscode/, and editor swap files.

CodeQL

New .github/workflows/codeql.yml — autobuild Go + GitHub Actions analysis on PR, push, and weekly cron. Results land in repo Security tab once enabled.

Settings already toggled (no diff)

The following were enabled live on the repo via gh api (not visible in this PR):

  • Secret scanning: enabled
  • Secret scanning push protection: enabled
  • Secret scanning non-provider patterns: enabled
  • Secret scanning AI detection: enabled

Out of scope

  • Replacing the personal @mayankpande88 @blue4209211 in CODEOWNERS with a team — user deferred this
  • Retroactively adding Apache headers to all 84 Go files that lack them

- Add NOTICE file crediting upstream forks (yahoo/kubectl-flame
  Copyright Verizon Media, josepdcs/kubectl-prof) and listing bundled
  third-party tools and their licenses, per Apache 2.0 §4(d)
- Add .github/workflows/codeql.yml: weekly + PR-triggered CodeQL scan
  for Go and GitHub Actions
- .gitignore: add .DS_Store, .vscode/, editor swap files
@mayankpande88 mayankpande88 enabled auto-merge (squash) May 12, 2026 11:12
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the .gitignore file to include common editor and OS temporary files and adds a NOTICE file documenting the project's licensing and heritage. Feedback suggests refining the .vscode ignore rules to allow sharing project-wide configurations and notes that the CodeQL workflow file mentioned in the PR description is missing from the changes.

Comment thread NOTICE
Comment thread .gitignore
CodeQL's Perform-Analysis step uploads results via the Code Scanning
API, which requires the 'code_security' feature. On a private repo
that needs GitHub Advanced Security; on a public repo it's free.
Until this repo flips public, leave the workflow out — adding it now
just produces a permanent red check.

Rest of the OSS-compliance commit (NOTICE, .gitignore hardening)
stays as-is.
@github-advanced-security
Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

@mayankpande88 mayankpande88 merged commit 7efe60e into main May 12, 2026
1 check passed
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