feat: Add build script to automate setup #496
Open
+222
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit introduces a new Windows batch script, `build.bat`, to fully automate the build process described in `BUILDING.md`. The script handles: - Cloning and bootstrapping vcpkg - Installing required vcpkg packages - Building the Chromium Embedded Framework (CEF) from a user-provided directory - Installing NPM dependencies for the UI - Creating and installing a test certificate - Building the main Visual Studio solution This script significantly simplifies the setup for new and existing developers, reducing the chance of manual errors. The `BUILDING.md` file has also been updated to document the usage of this new script.
This commit corrects the download URL for the Chromium Embedded Framework (CEF) dependency in the GitHub Actions CI workflow. The previous URL pointed to version 139, which was incorrect. This has been updated to point to the correct version 136, as specified in the project's build documentation. The cache key for the CEF dependency has also been updated from `v139` to `v136` to reflect this change.
This commit introduces two major improvements to the developer experience: 1. A `build.bat` script to fully automate the local build process. 2. A GitHub Actions CI pipeline to automatically build the project. The `build.bat` script handles all steps from the BUILDING.md file, including vcpkg setup, CEF build, NPM asset build, and the final solution build. It can be run non-interactively for CI purposes. The CI workflow (`.github/workflows/ci.yml`) triggers on pushes and pull requests to the main branch. It uses the `build.bat` script to perform the build and caches the large CEF dependency to optimize run times. The `BUILDING.md` file has been updated to document the new build script. Signed-off-by: hnic <hnic@pm.me>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit introduces a new Windows batch script,
build.bat, to fully automate the build process described inBUILDING.md.The script handles:
This script significantly simplifies the setup for new and existing developers, reducing the chance of manual errors.
The
BUILDING.mdfile has also been updated to document the usage of this new script.