Complete End-to-end guide for professional Julia development guide

I find that it’s actually hard to find info on how to do professional Julia development from end to end.

By that I mean

  1. How to set up a Julia repo on Github/Gitlab (use PkgTemplates.jl)
  2. What to include in the repo to trigger testing and code coverage tests (not sure ???)
  3. Set up testing properly (Just use the examples in test folder)
  4. Set up doc strings (Follow the documentation)
  5. Compile the Doc strings into documentation HTML (not sure)
  6. Host that HTML on Github/Netlify etc (not sure, Documenter.jl seems quite complex).
  7. Reigstering and Release the package (via JuliaReigstrator)

I come from R where I use RStudio and it’s quite a breeze, but I find it quite hard.

Am I missing some points?

I mean all of those things are there but I find it to be disparate. So a single post walking through all of those from end to end would be nice. Or a book really.

3 Likes

I don’t think there is enough material here for a book, but you could write a short blog post collecting the relevant pointers.

Each step is documented in detail, but IMO that should not be duplicated or consensed, as the underlying packages/procedures do change occasionally. Just links should be fine.

FWIW, I don’t think that finding this information is that hard though; the actual steps are analogous in all modern languages with a FOSS ecosystem, it’s just the details that differ.

2 Likes

I struggled with building the documentation at first using GithubActions. But really the process boils down to reading the manual for PkgTemplates. I’m not sure if that exists but maybe an ‘example workflow’ in the manual would be good.

2 Likes

To me it feels too “engineering”, one may doesn’t have enough motivation to read through such a post if he or she doesn’t have a concrete task in their mind. For example, there’re so many people who never read through a complete Git tutorial and just search and ask “how to return a history version”.

1 Like

Nice. At least a certain proportion of the population don’t feel like what i like. Cool.

1 Like

I have created a minimal package and documented how to generate it. Maybe this can be used as a basis for a tutorial

1 Like

Have you seen this?

3 Likes