search

nlbdev / nordic-epub3-dtbook-migrator

Tools for converting between a strict subset of DTBook and EPUB3.
http://nlbdev.github.io/nordic-epub3-dtbook-migrator/
GNU Lesser General Public License v2.1
8 stars 7 forks source link

Document release process #501

Closed josteinaj closed 2 years ago

josteinaj commented 2 years ago

I have changed from sonatype + maven central to using a branch on Github as a maven repository. It makes it easy for anyone with access to this repository to make a release. The documentation in the README should also be up to date now (but of course, there's always room for improvement). The guidelines-revision branch is still not merged to master, but that's just a matter of time (very soon).

egli commented 2 years ago

I have changed from sonatype + maven central to using a branch on Github as a maven repository

That seems a bit unconventional. I helped to automated the release process for liblouis-nar using github actions. At first we used the github package archive which was very easy to set up, see Publishing packages to GitHub Packages. But Bert wanted to use a more standard repo so we ended up with a slightly more complicated workflow, see the workflow file.

josteinaj commented 2 years ago

I tried Github Packages for spell-no. It worked great, but it requires authentication to download artifacts which is annoying. I've read that GitLab has something similar that works without authentication, which could be an alternative.

Using a separate branch is a bit unconventional, yes, so it wasn't my first choice. But it's not something I've invented either. I've based it on what others are doing.

My reason for using a branch is that it is much simpler for new developers to make a release.

The nordic migrator doesn't really need to be in a maven repository at all. It just needs the JAR file to be hosted somewhere and available for download. So one could argue that using Github releases would be better, if we don't need a maven repo. It's not used as a maven artifact in any build process as far as I'm aware of.

But if we can fully automate the release process to maven central through sonatype that would be great. Do you think it would be straight forward to do that for this project?