# Analysis of build problem
I'll also insert this into the issue description above.

1 of the problems here was the build process. I have fixed it and noted a 
further opportunity for improvement below.

There are 2 build jobs that should have been uploading images next to the 
compiled docs, but neither of them were. They were
1. GitHub action "Build cf-conventions HTML and pdf"
1. Travis `after_success` job that builds the docs and uploads them to 
`gh-pages`

Probably it took a while to notice this because the PDF is completely 
self-contained, so it might have been that maintainers (e.g. myself) were 
looking at that doc rather than the HTML in order to sanity check builds, and 
relying on proper exit codes as confirmation that all was well. Not so with 
HTML, which uses external assets that need to exist alongside the files. This 
issue wasn't specific to #276 but since images had previously not been used in 
the Conventions there was no reason it would have been a problem.

Both of these are now corrected.

**Opportunity for improvement:**
1. First of all I find it a bit confusing to have builds on both Travis and 
GitHub Actions. If we ever get the time it might be a good idea to refactor 
this. This is especially important because the build process must be maintained 
ATM in 2 places, meaning I had to make changes to 2 files to fix this issue 
this time round.
1. The `after_success` job in Travis only builds on `master` and release tags. 
Thus we only see issues like this for those tags; we may want to have an 
experimental build branch for Travis, as I did in an ad-hoc way, if we keep the 
Travis builds.

@neumannd please let me know when you've committed your changes to the index 
ordering to finalise this PR. Feel free to use the PR I've already started.

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/cf-convention/cf-conventions/issues/295#issuecomment-687015585

This list forwards relevant notifications from Github.  It is distinct from 
[email protected], although if you do nothing, a subscription to the 
UCAR list will result in a subscription to this list.
To unsubscribe from this list only, send a message to 
[email protected].

Reply via email to