docs: remove needless scripts #1949
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
cb22
reviewed
May 13, 2024
README.md
Outdated
| @@ -179,7 +179,8 @@ First grab the sources and run the setup script: | |||
| ```console | |||
| git clone https://github.com/tigerbeetle/tigerbeetle.git | |||
| cd tigerbeetle | |||
| scripts/install.sh | |||
| ./scripts/install_zig.sh | |||
There was a problem hiding this comment.
Ah! Let's point the user to the quick start instructions above? They no longer need source to benchmark.
There was a problem hiding this comment.
I removed this section altogether. I don't think it's possible to meaningfully use these benchmarks unless you know quite a bit more than we are saying here.
cb22
reviewed
May 13, 2024
.github/ci/benchmark/tigerbeetle.hcl
Outdated
| @@ -99,7 +99,7 @@ git clone ${var.git_url} | |||
| cd tigerbeetle | |||
| git checkout ${var.git_ref} | |||
| ./scripts/install_zig.sh | |||
| ./zig/zig build install -Drelease -Dconfig=production | |||
| ./zig/zig build -Drelease -Dconfig=production | |||
There was a problem hiding this comment.
We can remove this whole folder too, unless you think it's useful to point people to... It's not actively used.
|
(the macOS yaml still references install.sh) |
* there's no need for `install.sh` when it's just `./scripts/install_zig.sh && ./zig/zig build -Drelease -Dconfig=production` * there's no need to call `zig build install`, install is the default step * git hook uses the wrong zig, and in general hooks are very developer-specific
I think it is quiet useless, because it doesn't explain what exactly is benchmarked and how to interpret the results.
matklad
force-pushed
the
matklad/no-scripts
branch
from
36a054f
to
8ca00f1
Compare
cb22
approved these changes
May 14, 2024
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.
install.shwhen it's just./scripts/install_zig.sh && ./zig/zig build -Drelease -Dconfig=productionzig build install, install is the default step