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

Automations for sparc.client #37

Merged
merged 20 commits into from
Jan 31, 2024
Merged

Automations for sparc.client #37

merged 20 commits into from
Jan 31, 2024

Conversation

athril
Copy link
Collaborator

@athril athril commented Jan 23, 2024

This pull request includes the following:

  • automated dynamic versioning of the sparc.client using setuptools_scm
    • no hard-coded version is hard coded in the code base
    • version is automatically inferred based on the latest tag
    • file src/sparc/client/_version.py is only included in PyPI release
  • automated tagging and releases of software with deployment to Github and PyPI after workflow dispatch (release.yml) Github actions for version release and PyPI deployment #33
  • automated generation of CHANGELOG.md based on commits in semantic versioning format Simplify releases with semantic versioning #35
  • updates to CI.yml workflow in order to validate incoming pull requests (CI.yml)
  • update to sphinx.yml workflow to launch only on main branch
  • updates to documentation

@athril athril requested review from hsorby and pcrespov January 23, 2024 18:00
Copy link

codecov bot commented Jan 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (87c7056) 100.00% compared to head (0a419f6) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #37   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            8         8           
  Lines          369       370    +1     
=========================================
+ Hits           369       370    +1     
Flag Coverage Δ
unittests 100.00% <100.00%> (?)

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.

.github/workflows/CI.yml Outdated Show resolved Hide resolved
.github/workflows/release.yml Outdated Show resolved Hide resolved
.github/workflows/release.yml Outdated Show resolved Hide resolved
.github/workflows/CI.yml Show resolved Hide resolved
.github/workflows/release.yml Outdated Show resolved Hide resolved
@athril
Copy link
Collaborator Author

athril commented Jan 24, 2024

I have also updated Sphinx.yml workflow. It seems it used to be launched and deploy docs on each pull request (should be run only on push to main). Please let me know what you think @pcrespov.

Copy link
Contributor

@hsorby hsorby left a comment

Choose a reason for hiding this comment

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

There are some review dog formatting issues to address.

@athril
Copy link
Collaborator Author

athril commented Jan 26, 2024

There are some review dog formatting issues to address.

All formatting issues have been resolved. Ready to merge?

@athril
Copy link
Collaborator Author

athril commented Jan 29, 2024

Thank you @pcrespov for approving the changes. Any other comments/suggestions @hsorby @bisgaard-itis ?
I would like to merge it by the end of the month at the latest.

@athril athril merged commit 3f3727c into nih-sparc:main Jan 31, 2024
5 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.

3 participants