Hi, We can add checks as suggested in [1] to verify, that the related files exist. That can be implemented easiliy via GitHub actions.
If we don't want to script (or generate script code), we could also implement a little Java helper to do the checks (or to generate the checks), i.e. check that for every .md / adoc we have a html file, if someone is more familiar writing Java. We should also fail, if we find "new" documentation or new html files, which aren't expected. This might be strict but that would enforce that we are updating our checks, so perhaps it would be better to write some tooling to run the checks, so we don't bother with manually updating checks. Might be a good "first issue" for someone who wants to contribute? Perhaps we can create a Jira for it and write some outline / description. Maybe someone wants to give it a try. Gruß Richard [1] https://github.com/apache/tomee-site-generator/pull/52 Am Donnerstag, dem 20.10.2022 um 16:23 -0700 schrieb David Blevins: > > On Oct 20, 2022, at 4:01 PM, Cesar Hernandez <[email protected]> > > wrote: > > > > I pulled the latest main branch locally and compile it (mvn compile > > -Djbake.http=true), but the server doesn't seem to be working. > > This PR add basic Github Action so we can validate building on each > > PR > > https://github.com/apache/tomee-site-generator/pull/52 we can add > > Jenkins > > pipeline too, but I'm doing git bisect to see how we can add a > > check(s) > > after maven build is successful in trying to validate from CI if > > all the > > JBake requirements are met. > > Some checks would be great. One thought that I had is that it's kind > of a problem that the Jenkins job always passes, even if not much > occurs and we end up with say just javadoc -- or no javadoc :) > > I did try to do a git bisect, but it didn't really work out as the > old revisions that reference the master branch may have worked then, > but definitely won't work now. I tried a couple things and gave up. > > In terms of checks one that would be critical would be to check to > see that an html file was created for every .md or .adoc file. If > not fail the build. > > That might be a little too strict at first as I'm sure we have a few > adoc files that have issues and don't render even when things are > good, but we could maybe get that list and 1) exclude them from the > check and 2) fix them over time and yank them from the exclude list. > > Some thoughts at least. > > > -David >
