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

Adding initial github actions #6

Merged
merged 9 commits into from
Nov 21, 2023
Merged

Adding initial github actions #6

merged 9 commits into from
Nov 21, 2023

Conversation

dgkf-roche
Copy link
Collaborator

@dgkf-roche dgkf-roche commented Nov 2, 2023

Adds

  • A Test workflow to build, test and calculate coverage for the module
  • A Deploy workflow for building a ghpages site

This PR does not attempt to resolve all package issues, only to get the infrastructure set up as a starting point. It appears that at the very least we have to update the development manifest to test against the latest julia release, or better yet remove the manifest since I think that's only considered a best practice for things like reproducible analysis.

@dgkf-roche dgkf-roche linked an issue Nov 2, 2023 that may be closed by this pull request
@dgkf-roche dgkf-roche changed the title [WIP] Adding initial github actions Adding initial github actions Nov 2, 2023
@danielinteractive
Copy link
Collaborator

Awesome. Thanks a lot @dgkf-roche !

@ya0 ya0 enabled auto-merge (squash) November 16, 2023 12:47
Copy link
Collaborator

@ya0 ya0 left a comment

Choose a reason for hiding this comment

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

Thanks for adding the website workflow. I just have two questions.

represents ``h(t)``
needs to be implemented for any `struct` that subtypes HazardBasedDistribution
"""
function hazard(dist::HazardBasedDistribution, t::Real) end

@doc raw"""
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why removing the @doc macro? It makes, it more explicit where the docstrings are.
Why remove the @doc raw? This is made for docstrings with latex.

See the syntax guide from julia: https://docs.julialang.org/en/v1/manual/documentation/#Syntax-Guide

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ah yeah, we can add it back in for the latex heavy ones. I just did a find and replace, but it does make sense to use for the ones that need a lot of characters escaped.

@@ -1,5 +1,4 @@
[deps]
Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
JointModels = "54f05ff3-c196-4f1a-acfd-0c2b8e4405db"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do the docs render without implicitly loading the JointModels module?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I don't think so. I don't remember exactly what the issue was, but I think it had some circular dependence. If I remember correctly, it was building the module as part of the documentation process so it can't be a dependency for itself.

When in doubt, I just looked at other projects in the Julia ecosystem to see what they did.

Copy link
Collaborator

@ya0 ya0 left a comment

Choose a reason for hiding this comment

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

I did not test the workflows (not sure how) but the build workflow will probably not run at the moment because of dependencies. This will have to be addressed in the future.

@ya0 ya0 merged commit 457fb4a into main Nov 21, 2023
2 checks passed
@ya0 ya0 deleted the 5-actions branch November 21, 2023 11:46
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.

[Feature Request]: Setup GitHub actions
3 participants