oxidecomputer / oxidecomputer/omicron

Check for license header with GH action

Open
#7,324 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
572
Forks
97
Avg merge
2d 12h
Merged PRs (30d)
96

Description

On many other repos we use the skywalking-eyes tool to make sure all relevant files have the appropriate license header. To do that here, we would set up the .licenserc.yaml and a github action. Here is how it looks in propolis:

https://github.com/oxidecomputer/propolis/blob/master/.licenserc.yaml
https://github.com/oxidecomputer/propolis/blob/master/.github/workflows/rust.yml#L37-L42

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Use the linked propolis files as the reference: inspect .licenserc.yaml and the .github/workflows/rust.yml lines 37-42. Set up the corresponding license configuration and GitHub Action in this repository, then verify that the workflow checks relevant files for the appropriate license header.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, rust
Domain
ci-cd
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.