fedora-java/howto

Java packaging HowTo

howto's Issues

Gradle on Fedora Packaging Guidelines

Quoting abstract from https://docs.fedoraproject.org/en-US/java-packaging-howto/

Abstract
This document aims to help developers create and maintain Java packages in Fedora. It does not supersede or replace Java Packaging Guidelines, but rather aims to document tools and techniques used for packaging Java software on Fedora.

Since gradle is not available on Fedora, I think it should be removed from Fedora Packaging Guidelines.

Remove version 26 and replace with snapshot

I think that we should reconsider how the HOWTO should be developed and versioned.

My idea is that we would be developing it only in master branch, which would reflect state of rawhide. Knowing how we love writing docs, they are unlikely to be added before corresponding code hits rawhide, so this should be fine. In (unlikely) case of new docs that need to be added for upcoming features (not yet available in rawhide), we could use feature branches. At some point of Fedora release (after branching, but before GA) we would create release branch from master. Release branch would not be changed except for major bugfixes.

If the above workflow is implemented then we should version 26 and replace it with snapshot.

Any comments or objections?

Add recommendations on packaging Gradle projects

After removing gradle from javapackages, we should document how a packager should package such projects.
Inspiration can be taken from Fedora packages such as aqute-bnd, objectweb-asm, lucene.

Document %_ivyxmldir

%_ivyxmldir should be documented in directory layout, similarly to %_mavenpomdir.

Recommend using mock to prevent issues with Maven local repository

Users doing local RPM builds may experience unexpected build behaviour due to pre-existing content in their Maven local repository. We should point it out explicitly and advise to use mock. For more info see thread on devel list

TravisCI fails on generating manpages HTML

After including manpages in appendix TravisCI build fails because these manpages are not available on Ubuntu. TravisCI should be configured to fetch these manpages from javapackages on GitHub.

Typo: replace "mnv" with "mvn"

There is one place in the document that refers to "%mnv_alias" instead of "%mvn_alias", in Section 7.1, Packaging Maven project

Document testing xmvn and javapackages snapshots

Related to fedora-java/javapackages#18, but should be done even in case Mock config is not added.

Include package diagram

Diagram of Java-related packages with dependencies (images/xmvn.svg) has been available since 2013, but it is not included in generated docs.

Calendar versioning

Currently HOWTO versions correspond to versions of Fedora release that giver HOWTO corresponds to. I think it would be better to make it use Calendar Versioning instead.

Document pom_xpath_replace

In fedora-java/javapackages#56 @mbooth101 reported that pom_xpath_replace is not documented.

Extend documentation about auto-build-requires

Although there are some mentions of xmvn-builddep and Mock pm_request, but I perhaps that this may be insufficient.

IMHO, builddep is a great feature, which has been available for almost 4 years. Together with Mock pm_request plugin it effectively enables auto-build-requires. Unfortunately I have a feeling that it is not used widely and often enough.

Broken markup on startpage

INCLUDE_ASCIIDOC(../version-links)

Is shown on https://fedora-java.github.io/howto/latest/

Hide TODO/FIXME notes from geterated output

Currently generated documentation contains comments that should rather be hidden from the user, but kept in source code. These comments include TODO/FIXME items or notes about persons working on particular sections.

Continuous build of Antora version

We need to have TravisCI (or another automation, like CentOS CI) build Antora version of the HOWTO and push generated code to some git repository (most likely on pagure.io), from where docs.fedoraproject.org will be able to pull it and integrate with the website.

Continuous delivery with Travis CI

It would be nice to automatically compile and deploy GH pages using Travis CI. Some inspiration: http://www.steveklabnik.com/automatically_update_github_pages_with_travis_example/

Update package diagram

Package diagram at images/xmvn.dia should be updated to current state, including:

• introduction of javapackages-local, ivy-local, gradle-local,
• introduction of maven-minimal and xmvn-minimal