Plans to generate Doxygen docs as part of Azure CI-style builds?

Plans to generate Doxygen docs as part of Azure CI-style builds?

[Rebecca Cran]

I was wondering if there are any near-term plans to start generating and 
publishing EDK2 Doxygen documentation as part of an Azure build - 
perhaps on a nightly or weekly basis?

If not, then I'll work on getting my copy of the docs available again 
since I've found them useful in the past.


Also, are there any plans to start publishing regular builds of OVMF and 
other platforms? I know there's the kraxel site that has OVMF builds, 
but if there aren't plans to do something similar then I might set 
something up myself.


-- 
Rebecca Cran

Re: Plans to generate Doxygen docs as part of Azure CI-style builds?

[Michael D Kinney]

Rebecca,

Those are both good ideas.  Have not had time to enable them yet.

Doxygen generated documentation into HTML on a site is possible.
There are some issues with the current CLI tool that does 
this where it generates random filename each build.  There is a
Doxygen config option to disable this behavior, so site updates
will not generate all new files every build.

We have considered generating binaries for OVMF and UEFI Shell
and posting them in the GitHub release page for a stable tag.
We could use a CI agent to do these release builds.

Mike

> -----Original Message-----
> From: Rebecca Cran <rebecca@bsdio.com>
> Sent: Monday, April 27, 2020 5:39 PM
> To: edk2-devel-groups-io <devel@edk2.groups.io>
> Cc: Sean Brogan <sean.brogan@microsoft.com>; Michael
> Kubacki <michael.kubacki@microsoft.com>; Bret Barkelew
> <Bret.Barkelew@microsoft.com>; Kinney, Michael D
> <michael.d.kinney@intel.com>
> Subject: Plans to generate Doxygen docs as part of
> Azure CI-style builds?
> 
> I was wondering if there are any near-term plans to
> start generating and
> publishing EDK2 Doxygen documentation as part of an
> Azure build -
> perhaps on a nightly or weekly basis?
> 
> If not, then I'll work on getting my copy of the docs
> available again
> since I've found them useful in the past.
> 
> 
> Also, are there any plans to start publishing regular
> builds of OVMF and
> other platforms? I know there's the kraxel site that
> has OVMF builds,
> but if there aren't plans to do something similar then
> I might set
> something up myself.
> 
> 
> --
> Rebecca Cran
> 

Re: [edk2-devel] Plans to generate Doxygen docs as part of Azure CI-style builds?

[Rebecca Cran]

Thanks. I might go ahead and enable the docs on bsdio.com in the meantime.

In terms of the OVMF and other platform builds, I was thinking something 
like https://artifact.ci.freebsd.org/snapshot/head/ where a new build 
would be made available to people for each change that's made in the 
repo - or perhaps less frequently, like once a day.


-- 

Rebecca Cran


On 4/27/20 6:50 PM, Michael D Kinney wrote:
> Rebecca,
>
> Those are both good ideas.  Have not had time to enable them yet.
>
> Doxygen generated documentation into HTML on a site is possible.
> There are some issues with the current CLI tool that does
> this where it generates random filename each build.  There is a
> Doxygen config option to disable this behavior, so site updates
> will not generate all new files every build.
>
> We have considered generating binaries for OVMF and UEFI Shell
> and posting them in the GitHub release page for a stable tag.
> We could use a CI agent to do these release builds.
>
> Mike
>
>> -----Original Message-----
>> From: Rebecca Cran <rebecca@bsdio.com>
>> Sent: Monday, April 27, 2020 5:39 PM
>> To: edk2-devel-groups-io <devel@edk2.groups.io>
>> Cc: Sean Brogan <sean.brogan@microsoft.com>; Michael
>> Kubacki <michael.kubacki@microsoft.com>; Bret Barkelew
>> <Bret.Barkelew@microsoft.com>; Kinney, Michael D
>> <michael.d.kinney@intel.com>
>> Subject: Plans to generate Doxygen docs as part of
>> Azure CI-style builds?
>>
>> I was wondering if there are any near-term plans to
>> start generating and
>> publishing EDK2 Doxygen documentation as part of an
>> Azure build -
>> perhaps on a nightly or weekly basis?
>>
>> If not, then I'll work on getting my copy of the docs
>> available again
>> since I've found them useful in the past.
>>
>>
>> Also, are there any plans to start publishing regular
>> builds of OVMF and
>> other platforms? I know there's the kraxel site that
>> has OVMF builds,
>> but if there aren't plans to do something similar then
>> I might set
>> something up myself.
>>
>>
>> --
>> Rebecca Cran
>>
>
> 
>