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

Move citation.cff validation to pre-commit check #165

Merged

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Mar 14, 2024

Description

This PR moves a CITATION.cff validation which currently operates through GitHub Actions workflow tests to a pre-commit check. As a result, I've also moved cffconvert out of the dev dependencies, updated the lockfile, and removed a small mention of the step within the docs.

Closes #160

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.

Copy link
Member

@kenibrewer kenibrewer left a comment

Choose a reason for hiding this comment

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

LGTM

@d33bs d33bs added the release-patch Creates a patch release (e.g. `v0.0.1`) label Mar 16, 2024
@d33bs
Copy link
Member Author

d33bs commented Mar 16, 2024

Thanks @kenibrewer ! Once the tests for this pass, I plan to merge and release a new patch to help include the functionality from #168 (which may be challenging or block progress for users).

@d33bs d33bs merged commit f50d42e into cytomining:main Mar 16, 2024
7 checks passed
@d33bs d33bs deleted the move-citation-cff-validation-to-pre-commit branch March 16, 2024 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-patch Creates a patch release (e.g. `v0.0.1`)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move cffconvert validate for CITATION.cff format validation to pre-commit check
2 participants