CarloLucibello / GraphNeuralNetworks.jl

Graph Neural Networks in Julia
https://carlolucibello.github.io/GraphNeuralNetworks.jl/dev/
MIT License
214 stars 47 forks source link

add JuliaFormatter to Github Workflows #253

Closed pri1311 closed 1 year ago

pri1311 commented 1 year ago

Hi, this PR aims to add JuliaFormatter to GitHub workflows.

Closes #238

I have adapted most of the code from OrdinaryDiffEq.jl and made a few changes.

I haven't added any specific options to the .JuliaFormatter.toml yet. I would appreciate it if you could point out the specifics for the code style GraphNeuralNetworks.jl follows from the list of options, if any.

Thanks.

codecov[bot] commented 1 year ago

Codecov Report

Merging #253 (2c01a47) into master (d9c9441) will decrease coverage by 0.21%. The diff coverage is 89.92%.

@@            Coverage Diff             @@
##           master     #253      +/-   ##
==========================================
- Coverage   81.96%   81.75%   -0.21%     
==========================================
  Files          17       17              
  Lines        1846     1864      +18     
==========================================
+ Hits         1513     1524      +11     
- Misses        333      340       +7     
Impacted Files Coverage Δ
src/msgpass.jl 72.41% <60.00%> (+0.98%) :arrow_up:
src/layers/basic.jl 76.92% <64.28%> (-4.33%) :arrow_down:
src/GNNGraphs/utils.jl 74.01% <82.22%> (-1.40%) :arrow_down:
src/GNNGraphs/gnnheterograph.jl 23.94% <83.33%> (ø)
src/layers/conv.jl 79.47% <92.71%> (+0.19%) :arrow_up:
src/GNNGraphs/datastore.jl 76.13% <92.85%> (ø)
src/GNNGraphs/gnngraph.jl 55.46% <93.75%> (+0.35%) :arrow_up:
src/GNNGraphs/query.jl 94.02% <93.87%> (ø)
src/GNNGraphs/transform.jl 97.48% <94.64%> (-0.36%) :arrow_down:
src/GNNGraphs/convert.jl 91.82% <100.00%> (ø)
... and 10 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Dsantra92 commented 1 year ago

The formatting checks are failing because some files are not formatted. Can you format the locally and commit them? For formatting, you can refer to JuliaFormatter.jl.

Also, do we need three format checks?

Dsantra92 commented 1 year ago

Also add the code-style to Readme like SciML?

CarloLucibello commented 1 year ago

Reminder for myself: after merging this, create a .git-blame-ignore-revs file https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view

Dsantra92 commented 1 year ago

LGTM

CarloLucibello commented 1 year ago

Mhmh, the failing test should tthe usual fluke with gat, let's trigger again

Dsantra92 commented 1 year ago

@pri1311 this pr triggers non-cache documentation :(. We should fix this here. See here for more details.

pri1311 commented 1 year ago

@Dsantra92 I am having trouble understanding the issue here. could you elaborate on it?

CarloLucibello commented 1 year ago

The problem is that whenever the pluto notebooks in the docs/tutorials/ folder are changed they have to be compiled locally to markdown files. The procedure is quite simple

  1. make sure you are on julia 1.8
  2. run julia --project=docs docs/make.jl
  3. commit and push the changes (the changed files should be in the docs/pluto_output folder)
Dsantra92 commented 1 year ago

Can you use Julia 1.8.2 for rendering instead of 1.8? Looks like cache didn't work.

Dsantra92 commented 1 year ago

Nice work! The documentation cache for Pluto is working perfectly.

CarloLucibello commented 1 year ago

Thanks both for looking into this!