averbraeck / djunits

Delft Java UNIT System for using strongly-typed quantities and units
BSD 3-Clause "New" or "Revised" License
1 stars 0 forks source link

Generation of site information and javadoc does not work anymore #23

Closed averbraeck closed 5 months ago

averbraeck commented 5 months ago

The generation of the site has not been working for quite a while now. The site and javadoc should be generated using a job on one of the Delft servers.

averbraeck commented 5 months ago

There are a number of issues that need to be updated:

1) Lots of javadoc errors... They are not caught when we deploy a version with github actions. This is, of course, wrong... Therefore, the github actions should try to build a site:

    - name: Build with Maven and check if site building works
      run: mvn clean site --file pom.xml

    - name: Build with Maven and test if signing works
      run: mvn clean package -P release --file pom.xml
      env:
        MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
averbraeck commented 5 months ago

2) The site building process has changed, and site.xml needs a few adaptations:

A. it needs an explicit skin. The site.xml files have been updated with:

  <skin>
    <groupId>org.apache.maven.skins</groupId>
    <artifactId>maven-fluido-skin</artifactId>
    <version>2.0.0-M8</version>
  </skin>

B. ${artifactId} does not work anymore and has to be preceded with project.. The project tag in site.xml therefore has to start with:

<project name="${project.artifactId} ${project.version}"

C. headers have changed. Make them explicit with:

  <bannerLeft>
    <name>${project.name}</name>
  </bannerLeft>

  <bannerRight>
    <name>${project.artifactId} ${project.version}</name>
  </bannerRight>

D. because of the new skins, do not refer to site.vm anymore. Therefore, remove the following line from pom.xml in the maven-site-plugin:

          <templateFile>src/site/site.vm</templateFile>
averbraeck commented 5 months ago

The generation has been tested and works now. There is yet again a site at https://djunits.org