better doc (and build) validation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



It seems like we keep hitting catastrophic build errors with minor doc
changes. The last one was introduced by a change I made to the
ceph-disk man page that updated the title:

https://github.com/ceph/ceph/pull/19241/commits/bd00560c20caeeb1ded211cb81533280338014d1

That change builds correctly (!) and will render just fine, and it was
merged after the docs build reported as successful.

However, this also made all subsequent binary builds break. This
disconnect has caused similar issues in the past. At some point the
docs build was completely broken for days, because there was no
visibility from pull requests.

To mitigate that, we now have the docs job building for every pull
request, regardless if it is only editing rst files (because, yes, one
can break the docs build with C++).

This has helped a lot, but it still falls short because the binary
build process for Ceph is different from how we build docs (including
man pages). This is why a successful docs build in a PR can still
break a binary build.

There are a couple of things that could help:

1) I don't entirely follow how CMake is building the man/doc pages,
but a job that tries to replicate that path could catch these
inconsistencies in PRs.

2) Build binaries on every PR, and report them as status.

I don't know enough of CMake to attempt #1, and #2 would cause
contributors a lot of pain because it would involve having to push to
ceph-ci.git always.

I am open to any other ideas or suggestions here.
--
To unsubscribe from this list: send the line "unsubscribe ceph-devel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [CEPH Users]     [Ceph Large]     [Information on CEPH]     [Linux BTRFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]
  Powered by Linux