archive-gh-me/yew
1
0
Fork 0
mirror of https://github.com/yewstack/yew.git synced 2025-12-08 21:26:25 +00:00
Code Issues Projects Releases Wiki Activity

ci, docs: fix CI benchmarks and benchmarking docs (#1955)

Browse Source 
* ci, docs: fix CI benchmarks and benchmarking docs

* ci: temporarily remove `labeled` requirement for benchmarks

* force CI

* force CI

* ci: restore label filters for benchmarks
This commit is contained in:
bakape 2021-07-19 02:10:15 +03:00 committed by GitHub
parent f2504f4a97
commit 74581b5861
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/benchmark.yml vendored
View File

@ -16,11 +16,11 @@ jobs:
steps:
- uses: actions/checkout@v2
with:
repository: yewstack/js-framework-benchmark
repository: bakape/js-framework-benchmark
- name: Configure benchmark
run: |
search="{ git = \"https://github.com/yewstack/yew\", branch = \"master\" }"
search="{path = \"PATH\"}"
replace="{ git = \"${{ github.event.pull_request.head.repo.html_url }}\", branch = \"${{ github.event.pull_request.head.ref }}\" }"
input=$(cat frameworks/keyed/yew/Cargo.toml)
output=${input//"$search"/"$replace"}

10
CONTRIBUTING.md
View File

@ -60,7 +60,7 @@ Alternatively, you can set the `ECHO_SERVER_URL` environment variable to the URL
When adding or updating tests, please make sure to update the appropriate `stderr` file, which you can find [here](https://github.com/yewstack/yew/tree/master/packages/yew-macro/tests/macro) for the `html!` macro.
These files ensure that macro compilation errors are correct and easy to understand.
These errors can change with each release of the compiler so they should be generated with the Rust version 1.51
These errors can change with each release of the compiler so they should be generated with the Rust version 1.51
(because some tests make use of const generics which were stabilized in that version).
To update or generate a new `stderr` file you can run `cargo make test-overwrite` in the `yew-macro` directory.
@ -85,11 +85,9 @@ Some components of Yew have dedicated benchmarks which can be run with the follo
cargo make benchmarks
```
There's also a benchmark for the framework as a whole. Running it is a bit more involved:
1. Fork and clone [yewstack/js-framework-benchmark](https://github.com/yewstack/js-framework-benchmark)
2. Update `frameworks/yew/Cargo.toml` with your fork of Yew and the branch for your changes
3. Open a new PR with your `Cargo.toml` changes
There's also a benchmark for the framework as a whole.
Simply clone [bakape/js-framework-benchmark](https://github.com/bakape/js-framework-benchmark)
and follow the repository's README.
Feel free to add new benchmark tests if the current benchmark coverage is insufficient!