Add GitHub action workflow #1
Conversation
.github/workflows/main.yml
Outdated
| - name: Cache opam repository | ||
| uses: actions/cache@v2 | ||
| with: | ||
| path: ~/.opam | ||
| key: ${{ runner.os }}-${{ hashFiles('*.opam') }}-${{ matrix.ocaml-version }} |
There was a problem hiding this comment.
Caching the entire switch is not a good idea. By default, setup-ocaml caches everything it can safely cache. (For example: ~/.opam/download-cache)
There was a problem hiding this comment.
I see. Thanks for the warning! Any pointers towards something that explains the risks? It seems like it can significantly speed up the cycle, so I'd be interested to know what the tradeoffs are.
There was a problem hiding this comment.
Currently this is the action/cache itself problem, but it breaks the cache in some cases. Also, caching the entire switch causes the problem of not pulling the latest version of packages unless you explicitly specify the version or use opam lock, which can sometimes delay the discovery of a problem you want to find.
There was a problem hiding this comment.
The dune-cache makes the opam install process a few times faster for many projects, so it's a better option to use dune-cache instead of caching the whole. (Perhaps triggering the build again will make the process a little faster in this PR from the next job.)
There was a problem hiding this comment.
I see! All clear now. Thanks so much for the tips here!
There was a problem hiding this comment.
Well, we can check the consistency of the installed opam packages by calling opam upgrade --fixup, but I don't think it's ideal for end-users to do that in all their workflows. So I don't really want to recommend that.
There was a problem hiding this comment.
Yes, this makes sense. This is another thing I'll use at my own risk ;)
|
I was just feeling particularly pedantic tonight, so I posted a few comments, but I think I should definitely have written these in the documentation. Sorry about that...! |
|
Your tips are entirely welcome and greatly appreciated, @smorimoto! It is a help to me, and if helps flag areas that a semi-comprehending user might need documented too, that's even better 🙂 |
|
Thank you for your kind words! My experience here has been quite helpful since I was going to write documentation and explanation next week. (I think it will be released officially after that.) |
|
I'm very glad to hear that! I'd hoped I might be of some use by being an early adopter. I'm excited for pending release 🎉 |
No description provided.