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

feat(dev): add improved makefile with additional helper commands #391

Merged
merged 2 commits into from
Apr 24, 2024

Conversation

kenibrewer
Copy link
Member

@kenibrewer kenibrewer commented Apr 2, 2024

Description

This adds an improved Makefile with several additional helper scripts to aid in development efforts.

What is the nature of your change?

  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • This change requires a documentation update.

Checklist

Please ensure that all boxes are checked before indicating that a pull request is ready for review.

  • I have read the CONTRIBUTING.md guidelines.
  • 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.
  • New and existing unit tests pass locally with my changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have deleted all non-relevant text in this pull request template.

@codecov-commenter
Copy link

codecov-commenter commented Apr 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.96%. Comparing base (16f3500) to head (7e05135).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #391   +/-   ##
=======================================
  Coverage   94.96%   94.96%           
=======================================
  Files          56       56           
  Lines        3137     3137           
=======================================
  Hits         2979     2979           
  Misses        158      158           
Flag Coverage Δ
unittests 94.96% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kenibrewer kenibrewer requested a review from d33bs April 2, 2024 01:59
@kenibrewer kenibrewer marked this pull request as ready for review April 2, 2024 01:59
Copy link
Member

@d33bs d33bs left a comment

Choose a reason for hiding this comment

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

Nice work @kenibrewer ! I left a minor comment about quoting. To help check syntax I used checkmake which might be good to include as a linting step for Makefile modifications (it complained about missing phony targets for all and clean but I don't think these are required). I also used shellcheck as a double check, which I feel is a great addition where any console scripting is used.

The previous content within the Makefile made it look similar to a Sphinx project default. As part of this, I think the make.bat file might also need an update (or possibly a removal). I believe the .bat is there to ensure Windows compatibility on systems which may not have make available. Double checking through Read the Docs, it didn't look like either the Makefile or make.bat are used. How would you feel about removing make.bat as part of this change?

As a future-facing thought: should we consider alternative devtooling task managers like Poe the Poet or others? I've had good luck with it lately in other projects and only bring it up if it serves as inspiration (no strong feelings either way). A nice side-effect of using these is that we may have fewer files / formats to maintain within the project.

Makefile Outdated Show resolved Hide resolved
@kenibrewer kenibrewer merged commit 0f4f8c4 into cytomining:main Apr 24, 2024
11 checks 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.

None yet

3 participants