windows: build docs and tweaks #7463
Conversation
ringerc
requested review from
niedbalski,
patrick-stephens,
fujimotos,
edsiper,
leonardo-albertovich and
koleini
as code owners
|
IDK why the docs-required label was added. No external docs are required. |
|
Here's an example run of the windows PR checker, invoked via "Actions" tab on my fork repo https://github.com/ringerc/fluent-bit , to show that the instructions in the new README are valid: https://github.com/ringerc/fluent-bit/actions/runs/5063461747 Since |
ringerc
force-pushed
the
windows-build-docs-and-tweaks
branch
from
fa6048d to
d8596fe
Compare
|
I think the PR template should also be changed to remove the request to run Valgrind, unless someone's going to make fluent-bit Valgrind-clean. Right now it's so noisy on |
|
Showing that running the windows workflow on my fork works as a way to build fluent-bit patches w/o needing to go through all the windows pain: https://github.com/ringerc/fluent-bit/actions/runs/5063461747/jobs/9090178755
Not pretty, for sure, and slow as can be, but good enough for one-shot work. It'd be a lot better if there was a base container image canned in ghcr with the deps preinstalled. |
ringerc
force-pushed
the
windows-build-docs-and-tweaks
branch
from
d8596fe to
ba8b78d
Compare
|
Fixed DCO |
patrick-stephens
changed the title
| # The build will fail later if flex and bison are missing, so there's no | ||
| # point attempting to continue. There's no test cover for windows builds | ||
| # without FLB_PARSER anyway. | ||
| message(FATAL_ERROR "flex and bison not found, see DEVELOPER_GUIDE.md") |
There was a problem hiding this comment.
I'd also say there's no way to actually build a lot of the plugins with FLB_RECORD_ACCESSOR=No as well
There was a problem hiding this comment.
Sensible, feel free to raise a suggestion on the PR and I'll merge
|
All looks fine, just the usual macOS failures @leonardo-albertovich |
|
Looks good, the only thing I would personally change would be switching chocolatey for vcpkg for openssl and libyaml but that's just because it's what I use. Lately I have been using it in a virtualized windows 11 environment in my mac which means I was able to install and use x86, x86_64 and aarch64 versions of those libraries side by side (I explicitly did the same thing in the three different developer shell types) and it worked perfectly. |
|
@leonardo-albertovich I'm not interested in expanding this cleanup to require more changes or testing than are scoped in the current PR - such as changing tools used to install things etc. This is meant to be a minimal and targeted PR for the issues I tripped over while trying to satisfy the requests for Windows support on my exec plugin patch. |
The dev guide had no references for how to build or test for windows at all. Add a short section with some minimal info and guidance for where to find more detailed resources. I didn't want to write extensive docs on this, especially as they're likely to be unmaintained and go stale, so the user is expected to look at the CI automation files to extract required library URLs, commands etc. Signed-off-by: Craig Ringer <[email protected]>
Windows builds will fail if flex, bison or the OpenSSL libraries are missing. So modify the CMake code to ensure that we fail at CMake time, rather than during the subsequent build. Signed-off-by: Craig Ringer <[email protected]>
Add comments on the Windows workflows to cross-reference them with each other and the new DEVELOPER_GUIDE.md docs section for Windows builds. Add a short note to the windows PR workflow on how to run it manually on a forked repo when submitting patches. Signed-off-by: Craig Ringer <[email protected]>
ringerc
force-pushed
the
windows-build-docs-and-tweaks
branch
from
ba8b78d to
8fbc1e9
Compare
|
This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days. |
Docs and minor CMake build tweaks for Windows builds
workflow_dispatchfor.github/workflows/pr-windows-build.yamlso users of forked repos can run it manually on their branches via their github repo Actions tab. The workflow must haveworkflow_dispatchin the default (master) branch for this to work, so it's sensible to have this pre-defined.Enter
[N/A]in the box, if an item is not applicable to your change.Testing
Before we can approve your change; please submit the following in a comment:
If this is a change to packaging of containers or native binaries then please confirm it works for all targets.
ok-package-testlabel to test for all targets (requires maintainer to do).Documentation
Backporting
Fluent Bit is licensed under Apache 2.0, by submitting this pull request I understand that this code will be released under the terms of that license.