Skip to content
This repository has been archived by the owner on Aug 31, 2023. It is now read-only.

Dockerised benchmark tool #4494

Merged
merged 4 commits into from
May 21, 2023
Merged

Conversation

connorjburton
Copy link
Contributor

Summary

Adding support for running the benchmark tool in Docker. The docker file has to be in the root, as it requires copying crates and xtask to compile rome.

This work greatly helps encouraging potential users of rome to compare the performance against other popular tools on their machine, which gives a much better insight on the peformance improvement they will see. Given that the performance improvement can vary wildly between machines (from ~25-100x faster than prettier for formatting).

It also has the additional benefit of a 1 line command and avoids installing dependencies to run the benchmark.

Test Plan

The documentation is updated with the command to be ran. This should be ran by someone else before merging this PR to ensure it works as expected.

Changelog

I don't believe this requires a changelog entry as it does not change the tooling itself.

  • The PR requires a changelog line

Documentation

The documentation is updated.

  • The PR requires documentation
  • I will create a new PR to update the documentation

@netlify
Copy link

netlify bot commented May 16, 2023

Deploy Preview for docs-rometools canceled.

Built without sensitive environment variables

Name Link
🔨 Latest commit 098c63b
🔍 Latest deploy log https://app.netlify.com/sites/docs-rometools/deploys/6463dc8b9a55af00086bfa6f

@@ -228,7 +228,7 @@ function cloneProject(name, repository, dirs = []) {
console.log(`Updating git repository in directory ${projectDirectory}`);
inProjectDirectory.run("git reset --hard @{u}");
inProjectDirectory.run("git clean -df");
inProjectDirectory.run("git pull --depth=1");
inProjectDirectory.run("git pull --depth=1 --ff-only");
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was needed as the rust image used did not have any configuration set for how to merge when pulling, so it would fail.

@ematipico
Copy link
Contributor

Thank you @connorjburton for opening the PR! I am going to checkout your branch when I have time and test it! 🚀

@ematipico ematipico requested a review from a team May 17, 2023 14:38
@ematipico ematipico added the A-Tooling Area: our own build, development, and release tooling label May 17, 2023
@ematipico ematipico merged commit ef6544c into rome:main May 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A-Tooling Area: our own build, development, and release tooling
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants