Could you elaborate how specifically having a generate docs task on by default is helping newcomers, and how code changes break docs? Also, are we talking about javadoc or documentation website?
On Thu, Apr 24, 2025, at 8:25 AM, Mick Semb Wever wrote: > Does this also apply to gradle, which now gets downloaded and installed, and > is the most recent addition ? > > The python requirement from gen-doc has been around for over three years now. > > I agree with the rationale that `ant` should default to `ant check`, keeping > newcomers in mind while being more just a final pre-commit action for > seasoned devs where `ant jar` is the typical dev loop. I'm sure this has > been discussed in the past. > > > > On Thu, 24 Apr 2025 at 08:16, Alex Petrov <al...@coffeenco.de> wrote: >> __ >> I didn’t say we should disable checks. I thought this was a purpose of CI : >> to check everything: there’s likely more to break semantically anyways, also >> harder to detect and fix. I’m also not proposing removing something that was >> long in place, these dependencies were introduced very recently. >> >> On Wed, Apr 23, 2025, at 11:51 PM, Jeremiah Jordan wrote: >>> I think the default build should be to build and check everything. I think >>> that if someone is new it is better to have everything built and checked by >>> default to flag issues. >>> >>> If someone knows what they are doing and wants to speed up the process it >>> is very easy to add the right settings to the ant command so things are >>> faster. >>> >>> -Jeremiah >>> >>> On Wed, Apr 23, 2025 at 4:36 PM Jordan West <jorda...@gmail.com> wrote: >>>> Should we consider making that the default and then passing false >>>> explicitly in CI/builds? I agree with Alex it’s a bit surprising and >>>> shorter build times when developing would be helpful. >>>> >>>> Jordan >>>> >>>> On Wed, Apr 23, 2025 at 13:37 Mick Semb Wever <m...@apache.org> wrote: >>>>> Python and Go are used by the gen-doc target. >>>>> >>>>> Code changes can break these, hence it is part of `ant check`. >>>>> It is not called by `ant jar` >>>>> >>>>> If you want to run check but skip it, it's to add >>>>> `-Dant.gen-doc.skip=true` >>>>> >>>>> >>>>> >>>>> On Wed, 23 Apr 2025 at 22:06, Alex Petrov <al...@coffeenco.de> wrote: >>>>>> __ >>>>>> Hi folks, >>>>>> >>>>>> Building Cassandra jar has been getting increasingly slow, and now it >>>>>> looks like we depend not only on python3 (which was already not >>>>>> optimal), but also on go: >>>>>> >>>>>> ant -Dno-checkstyle=true >>>>>> >>>>>> ... >>>>>> >>>>>> [exec] python3 ./scripts/gen-nodetool-docs.py >>>>>> [exec] python3 ./scripts/convert_yaml_to_adoc.py >>>>>> ../conf/cassandra.yaml >>>>>> ./modules/cassandra/pages/managing/configuration/cass_yaml_file.adoc >>>>>> [exec] ./scripts/process-native-protocol-specs-in-docker.sh >>>>>> [exec] Go env not found in your system, proceeding with >>>>>> installation. >>>>>> [exec] Downloading Go 1.23.1... >>>>>> [exec] Installing Go 1.23.1... >>>>>> [exec] Building the cqlprotodoc... >>>>>> [exec] Cloning into 'cassandra-website'... >>>>>> [exec] Your branch is up to date with 'origin/trunk'. >>>>>> [exec] go: downloading github.com/mvdan/xurls v1.1.0 >>>>>> [exec] Processing the .spec files... >>>>>> >>>>>> I personally consider this extremely dangerous, but also unnecessary. My >>>>>> current stance is that functionality introducing python3 and go should >>>>>> be moved to a separate task that only runs on demand / ci / release. I >>>>>> welcome convincing arguments that would suggest otherwise. >>>>>> >>>>>> If you agree we should not require python and go to run `ant >>>>>> -Dno-checkstyle=true`, please also write a short message, this will be >>>>>> very helpful as well. >>>>>> >>>>>> Thank you, >>>>>> --Alex >>
