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

Tidy GitHub workflows #655

Merged
merged 7 commits into from
Oct 22, 2024
Merged

Tidy GitHub workflows #655

merged 7 commits into from
Oct 22, 2024

Conversation

alexdewar
Copy link
Collaborator

@alexdewar alexdewar commented Oct 17, 2024

As with many of our projects, FINESSE currently has one large workflow file which does several different things (running tests, building documentation, building release artifacts) and I thought it would be cleaner to try to separate this out a bit.

Specifically:

  • I made separate composite actions for installing dependencies, building the docs and building the EXE file
  • I made two new workflows for deploying the documentation and uploading the release artifacts (viz. generated EXE file)

The docs workflow uses the new GitHub Actions method for deploying docs rather than the gh-pages branch, which brings a few advantages. I tested that the action actually works by deploying from this branch.

Copy link

codecov bot commented Oct 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.80%. Comparing base (6d86e1b) to head (577d0b8).
Report is 12 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #655      +/-   ##
==========================================
+ Coverage   84.67%   84.80%   +0.12%     
==========================================
  Files          69       69              
  Lines        3452     3448       -4     
==========================================
+ Hits         2923     2924       +1     
+ Misses        529      524       -5     

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

@alexdewar alexdewar requested review from dalonsoa and dc2917 and removed request for dalonsoa October 17, 2024 16:17
@alexdewar alexdewar marked this pull request as ready for review October 17, 2024 16:27
Copy link
Contributor

@dalonsoa dalonsoa left a comment

Choose a reason for hiding this comment

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

This is pretty cool! I didn't know about "composite" and I bet others don't know, either. I suggest you report this in Teams or in the next team meeting.

.github/workflows/ci.yml Outdated Show resolved Hide resolved
Co-authored-by: Diego Alonso Álvarez <6095790+dalonsoa@users.noreply.github.com>
@alexdewar
Copy link
Collaborator Author

This is pretty cool! I didn't know about "composite" and I bet others don't know, either. I suggest you report this in Teams or in the next team meeting.

Neither did I but it seems handy! I'll bring it up in the team meeting.

@alexdewar alexdewar enabled auto-merge October 22, 2024 08:28
@alexdewar alexdewar merged commit 1d9db34 into main Oct 22, 2024
8 checks passed
@alexdewar alexdewar deleted the tidy-workflows branch October 22, 2024 08:34
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