Fix custom agent build instructions#248
Merged
Merged
Conversation
Currently, README.md suggests that running `hatch run build:me --keep-agent` will keep the agent binary from the `src/appsignal` directory intact. But as a part of the build environment setup, `hatch` installs project in development mode, which runs the `src/scripts/build_hook.py` script. This results in the script discarding the local binary, despite the `--keep-agent` flag. This change adds `_APPSIGNAL_BUILD_AGENT_PATH` env variable to the build script, so that it is picked up by the project installation and build steps. [skip ci]
lipskis
added
chore
|
✔️ All good! |
Member
|
I'll let Noemi review this. I know she worked on this before :) |
tombruijn
removed their request for review
October 7, 2025 12:52
unflxw
approved these changes
Oct 7, 2025
unflxw
left a comment
unflxw
left a comment
Contributor
There was a problem hiding this comment.
Thanks for fixing this! It's bitten me in the past :)
Remove `--keep-agent` argument from `build:me` script definition, to avoid overwriting `_APPSIGNAL_BUILD_AGENT_PATH` with an empty string.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Currently, README.md suggests that running
hatch run build:me --keep-agentwill keep the agent binary from thesrc/appsignaldirectory intact. But as a part of the build environment setup,hatchinstalls project in development mode, which runs thesrc/scripts/build_hook.pyscript without the--keep-agentflag. This results in the script discarding the local binary.This change adds the
_APPSIGNAL_BUILD_AGENT_PATHenv variable to the build script in README.md and removes the--keep-agentargument from thebuild:mescript definition inpyproject.tomlso that the env variable is picked up by the project installation and build steps.[skip ci]
[skip changeset]