Skip to content

feat: add abstract workflows for coverage, linting, testing, reuse, and scorecard - #34

Open
seantronsen wants to merge 5 commits into
mainfrom
seantronsen/feat/add-missing-workflows
Open

seantronsen wants to merge 5 commits into
mainfrom
seantronsen/feat/add-missing-workflows

Conversation

@seantronsen

@seantronsen seantronsen commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

Description

Please include a summary of the change and which issue is fixed.
Also include relevant motivation and context.

Fixes #27, #28, #29, #30

Checklist

  • My code follows the style guidelines of this project
  • I have added/updated comments where needed
  • I have added tests that prove my fix is effective or my feature works
  • I have run make test (or equivalent) locally and all tests pass
  • I have updated the relevant documentation (CLI examples, man pages, README, other docs, etc.)
  • DCO Sign-off: All commits are signed off (git commit -s) with my real name and email
  • REUSE Compliance:
    • Each new/modified source file has SPDX copyright and license headers
    • Any non-commentable files include a <filename>.license sidecar
    • All referenced licenses are present in the LICENSES/ directory

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Dependency update
  • Build system/CI

…nd scorecard

Signed-off-by: Sean Tronsen <sean.tronsen@gmail.com>
@seantronsen seantronsen self-assigned this Sep 16, 2026
@seantronsen seantronsen linked an issue Sep 16, 2026 that may be closed by this pull request
1 task
@synackd synackd changed the title feat: add abstract workflows for coverage, linting, testing, reuse, ... feat: add abstract workflows for coverage, linting, testing, reuse, and scorecard Sep 16, 2026
alexlovelltroy
alexlovelltroy previously approved these changes Sep 16, 2026

@synackd synackd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Largely looks good, thanks for the contribution!

Just a couple of small things and improvement ideas.

Comment thread .github/workflows/lint-go.yml Outdated
Comment thread .github/workflows/scorecard.yml Outdated
Comment thread README.md Outdated
Comment thread .github/workflows/lint-go.yml
Comment thread .github/workflows/reuse.yml Outdated
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- uses: fsfe/reuse-action@676e2d560c9a403aa252096d99fcab3e1132b0f5 # v6.0.0

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I didn't see a way to do this in the official REUSE action, but it's nice to be able to see which files are non-compliant. I managed to do this in the ochami CLI with a more manual approach if you'd like to reference it. See:

https://github.com/OpenCHAMI/ochami/blob/main/.github/workflows/reuse.yaml

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Wondering if we should allow overriding the REUSE version and default to 6.2.0.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I worry that will cause maintenance headaches. Aside from the helper bot updating versions, it would be pretty easy to forget to update the reuse version in repo X. Then for N unique repos...

I think it could be a nice-to-have, but w.r.t. maintenance, the cons outweigh the pros for me.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I worry that will cause maintenance headaches.

How is it different than remembering to update the hard-coded version as you have it?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I worry that will cause maintenance headaches.

How is it different than remembering to update the hard-coded version as you have it?

It would only be hardcoded in this repo as opposed to needing N repos to remember to update another value. Of course, either way N repos will need to keep the workflow ref up to date.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I worry that will cause maintenance headaches.

How is it different than remembering to update the hard-coded version as you have it?

It would only be hardcoded in this repo as opposed to needing N repos to remember to update another value. Of course, either way N repos will need to keep the workflow ref up to date.

Right, and it would still only be defined here as the default. Other repos could change it for temporary purposes, but the default version would have its source of truth here.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

In other repos, you would just leave the default unless there was an issue with the version, in which case the input would allow temporary change.

@seantrons seantrons Sep 17, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

@synackd you drive a hard bargain, but I see your point. I'm still stuck at the office, but I'll get it implemented once I get back home.

Comment thread .github/workflows/scorecard.yml
Signed-off-by: Sean Tronsen <sean.tronsen@gmail.com>
Signed-off-by: Sean Tronsen <sean.tronsen@gmail.com>
Signed-off-by: Sean Tronsen <sean.tronsen@gmail.com>
Signed-off-by: Sean Tronsen <sean.tronsen@gmail.com>
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.

[DEV]: Reuse compliance check [Feature]: New workflows for deduplication across the org

4 participants