PR10155 changes the Doxyfile from static to being generated by the build system. When the Doxyfile is static, it can be pulled from the repo without any changes and compiled by doxygen (which the host does today). D3508 changes Doxyfile -> Doxyfile.in which must be compiled by the build system prior to passing to doxygen. We pull the compiled Doxyfile from latest, known good TeamCity artifacts in order to deploy.
Details
Details
# build the docker image # These env variables will be provided by the TeamCity infra and are only here to demonstrate how to test locally export TEAMCITY_USERID="<your username>" export TEAMCITY_PASSWORD="<your password>" export TEAMCITY_URL="https://build.bitcoinabc.org" docker build -t abc-docs -f Dockerfile-doxygen --build-arg TEAMCITY_USERID --build-arg TEAMCITY_PASSWORD --build-arg TEAMCITY_URL . # run the docker image (nginx static HTML) docker run --rm -p 4000:80 abc-docs
Diff Detail
Diff Detail
- Repository
- rABC Bitcoin ABC
- Branch
- doxydocker
- Lint
Lint Passed - Unit
No Test Coverage - Build Status
Buildable 6606 Build 11259: Bitcoin ABC Buildbot (legacy) Build 11258: arc lint + arc unit
Event Timeline
Comment Actions
The host serving the doc should probably not be the one building it. The description of the diff doesn't explain why this is necessary.
Comment Actions
I read the rationale and did not understand any of it. It seems like Doxyfile is generated by the build system now, but that doesn't explain why it has to be done on the machine hosting the doc. If deploying artifacts on host is something that is challenging, then it seems like this problem should be talked, because this is pretty much the ONLY thing that deployment does.
Comment Actions
Tested against new TeamCity artifacts and fixed some bugs associated with the previous change.
Comment Actions
If whatever is calling this dockerfile has these parameters, then wouldn't that be better to simply download the file and copy it within the docker image ?
I don't have much experience with teamcity, but this way of doing things by download an artifact over the internet seems HIGHLY suspicious and do not seem very necessary. British airways just learned that lesson the hard way. Everybody's laughing their ass off while doing the same.
In addition, one has to wonder what this does at the root of the source code tree. This is clearly completely useless to anyone who has a different infra setup.
Comment Actions
The intent here was to not hide these details in the TeamCity configuration. The TeamCity config already hides some of this logic away from the source repo. It isn't right, but no one has the time to migrate them just quite yet.
There is a way to instruct the TeamCity agent to download the artifact before building the docker image, but again it was against the rationale in the short/mid term.
There are a lot of improvements that we're missing on this front (basically everything touched by TeamCity). I can revisit these once the bulk of our release process is automated (freeing up even more time to do so). Coincidentally, I'm learning more and more about how TeamCity works while I progress on these tasks. When the time comes to migrate all of the configs to in-repo, I believe the migration will be rather smooth. Until then, I think it's best we move forward on this low-impact side-task.
Comment Actions
Thought about it some more and realized there are other benefits to doing it the other way.