Skip to content

Commit

Permalink
doc(repo): Document maintenance (#6145)
Browse files Browse the repository at this point in the history
  • Loading branch information
kdy1 committed Oct 14, 2022
1 parent ef5ed9b commit f1bb365
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions MAINTENANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# SWC maintenance

This document describes a way to manage/publish the swc repositories. These tasks are all done by me (`@kdy1`) previously, but as the project got much bigger, I'm writing this document to allow the other core team members do it.

## swc-project/swc

This is the main repository. To help rust-side users, swc publishes changed crates everytime a PR is merged. The publish action is done by `@swc-bot`.

To control the bot, we use a review comment ending with yaml. The yaml should start with `swc-bump` and should be the last in the comment. An example of such comments is

```
Content about the PR
---
swc-bump:
- swc_atoms
- swc_ecma_ast --breaking
```

and this comment should be written by `@kdy1` at the moment. You can change this to allow more people by fixing [the bot script](https://github.com/swc-project/swc/blob/e46a192cb6b3281408d688b7bbf65c225ef6780e/scripts/bot/src/cargo/comment-parser.ts#L6).
Once PR is merged, the bot script will automatically publish crates and rebase another PR with auto-merged enabled.

If you want to publish crates manually, you can do `cargo mono publish --no-verify` after installing `cargo-mono`.

## swc-project/plugins

When you need to publish crates in `swc-project/plugins`, you can use `./scripts/update-bump-all.sh` to update dependencies and bump versions of crates and npm packages.
Just like the main swc repository, the CI script will automatically publish all crates and npm packages when a PR is merged.

1 comment on commit f1bb365

@github-actions
Copy link

Choose a reason for hiding this comment

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

Benchmark

Benchmark suite Current: f1bb365 Previous: d334c6e Ratio
es/full/minify/libraries/antd 1987856842 ns/iter (± 368416315) 1835605752 ns/iter (± 33990897) 1.08
es/full/minify/libraries/d3 409885927 ns/iter (± 21932239) 382662590 ns/iter (± 9389147) 1.07
es/full/minify/libraries/echarts 1637754350 ns/iter (± 148982497) 1499412969 ns/iter (± 37242714) 1.09
es/full/minify/libraries/jquery 113643273 ns/iter (± 14534409) 108889122 ns/iter (± 7710514) 1.04
es/full/minify/libraries/lodash 121468816 ns/iter (± 9246307) 119918517 ns/iter (± 15788258) 1.01
es/full/minify/libraries/moment 61228714 ns/iter (± 3281967) 61333707 ns/iter (± 3629062) 1.00
es/full/minify/libraries/react 22635996 ns/iter (± 1208175) 20839472 ns/iter (± 657978) 1.09
es/full/minify/libraries/terser 311686750 ns/iter (± 7552128) 316413894 ns/iter (± 9960771) 0.99
es/full/minify/libraries/three 570465801 ns/iter (± 18290456) 568830752 ns/iter (± 19534274) 1.00
es/full/minify/libraries/typescript 3469977403 ns/iter (± 102276923) 3660215404 ns/iter (± 660756876) 0.95
es/full/minify/libraries/victory 797991883 ns/iter (± 23253423) 876661032 ns/iter (± 47330961) 0.91
es/full/minify/libraries/vue 140654979 ns/iter (± 8825832) 170811011 ns/iter (± 14684491) 0.82
es/full/codegen/es3 32941 ns/iter (± 541) 34448 ns/iter (± 1354) 0.96
es/full/codegen/es5 32603 ns/iter (± 1385) 33590 ns/iter (± 1258) 0.97
es/full/codegen/es2015 32934 ns/iter (± 1740) 33955 ns/iter (± 2527) 0.97
es/full/codegen/es2016 32818 ns/iter (± 1459) 34019 ns/iter (± 4904) 0.96
es/full/codegen/es2017 32994 ns/iter (± 517) 33655 ns/iter (± 1111) 0.98
es/full/codegen/es2018 32918 ns/iter (± 818) 33939 ns/iter (± 2611) 0.97
es/full/codegen/es2019 32892 ns/iter (± 604) 34113 ns/iter (± 4393) 0.96
es/full/codegen/es2020 32890 ns/iter (± 1347) 34889 ns/iter (± 3230) 0.94
es/full/all/es3 189394199 ns/iter (± 9585131) 214127632 ns/iter (± 35940118) 0.88
es/full/all/es5 178628062 ns/iter (± 6533241) 202510552 ns/iter (± 16560685) 0.88
es/full/all/es2015 147836098 ns/iter (± 7121362) 162175663 ns/iter (± 12605086) 0.91
es/full/all/es2016 151837463 ns/iter (± 9984039) 163086668 ns/iter (± 15614714) 0.93
es/full/all/es2017 156603439 ns/iter (± 11408230) 165838850 ns/iter (± 26415606) 0.94
es/full/all/es2018 148957109 ns/iter (± 10637907) 158682567 ns/iter (± 15080456) 0.94
es/full/all/es2019 142996957 ns/iter (± 3800227) 161713281 ns/iter (± 13066180) 0.88
es/full/all/es2020 135947520 ns/iter (± 7250039) 156950329 ns/iter (± 36047548) 0.87
es/full/parser 711168 ns/iter (± 18363) 747873 ns/iter (± 48044) 0.95
es/full/base/fixer 26395 ns/iter (± 873) 26636 ns/iter (± 7278) 0.99
es/full/base/resolver_and_hygiene 92327 ns/iter (± 2792) 98503 ns/iter (± 17256) 0.94
serialization of ast node 206 ns/iter (± 6) 210 ns/iter (± 5) 0.98
serialization of serde 208 ns/iter (± 4) 210 ns/iter (± 116) 0.99

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.