Repository navigation
Add MemBrowse memory tracking - #153
Open
michael-membrowse wants to merge 1 commit into
Open
michael-membrowse wants to merge 1 commit into
michael-membrowse wants to merge 1 commit into
Conversation
Build the nRF52840 example on pushes to master and on pull requests and upload a memory report to MemBrowse. PRs, including ones from forks, get a single comment that is updated on later pushes, posted by a workflow_run-triggered workflow. An onboard workflow backfills history on demand. Add the MemBrowse badge to the README.
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
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.
As discussed in #104, @diondokter was interested in a PR adding MemBrowse memory tracking. Sorry it took me so long to open it! It addresses the three problems with the current binary-size comments:
workflow_runworkflow then posts the comment with the base repo's token, so the comment appears no matter who opens the PR.Addresses #104
What's in this PR
membrowse-report.ymlbuilds the nRF52840 example with the same nightly and build-std setup as thebinary-sizejob, on pushes to master and on PRs. It also writes a linker map, so sizes are attributed to crates and object files.membrowse-comment.ymlposts or updates the PR comment once the report finishes.membrowse-onboard.ymlis a manual workflow that backfills history.Setup
MEMBROWSE_API_KEYand paste the API key as the value.https://github.com/tweedegolf/sequential-storage, then toggle Public Access on.panic_immediate_abortbuild-std feature, so history effectively starts there.Until the secret is set, the MemBrowse report job will fail on pushes to master and the comment workflow skips itself. The other CI jobs are not affected.
Preview
This is running on my fork, for the nRF52840 example: https://membrowse.com/public/michael-membrowse/sequential-storage/target/nrf52840-example
The current example uses 18,428 bytes of FLASH (1.8%) and 1,752 bytes of RAM (0.7%).