Chore: Centralize some Repository Config #4422
Merged
Conversation
This file contains 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
reneme
force-pushed
the
chore/repo_config
branch
from
e1b93a8
to
7bea280
Compare
This is meant to centralize auxiliary configuration that is mostly used to test the library in Continuous Integration. This is explicitly not meant to influence the actual build of the released parts of the library.
reneme
force-pushed
the
chore/repo_config
branch
from
7bea280
to
584db02
Compare
|
@reneme seems to be a problem with the SDE job can you take a look https://github.com/randombit/botan/actions/runs/11640528851/job/32421150718 |
|
I accidentally removed the $PATH amendment. Therefore, the |
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 centralizes some repo-specific configuration into
src/configs/repo_config.env. The settings are pulled into the CI's environment using a new GitHub action in.github/actions/read-repo-config.The configuration in this file is relevant mostly for CI at the moment. Hence, no build scripts that are meant to be run locally are relying on those variables; perhaps except
ci_build.py. In case that ever changes, thesrc/scripts/repo_config.pymay be used to query the settings, either as a convenient CLI, or as a python module. E.g.python3 src/scripts/repo_config.py get BORINGSSL_REPO # prints 'randombit/boringsslor
This is an initial proposal. There's most likely more info that could live in such a config file. Also, I'm certainly open to criticism and improvement proposals with this. We use a similar setup in sehlen-bsi/botan-docs and that proved to be fairly useful.
Currently "Setup Build Agent" and "Read Repository Config" are deliberately split into two actions for flexibility in the setup of CI workflows. Though, at the moment they are always used together. Perhaps it makes sense to simply read the config in the setup job.
Closes #4390