2018-09-13 00:23:22 +08:00
2018-09-26 11:03:13 +08:00
## Issue
Welcome to use [issue tracker ](https://github.com/alibaba/arthas/issues ) to give us :bowtie::
* feedbacks - what you would like to have;
* usage tips - what usages you have found splendid;
* experiences - how you use Arthas to do **effective** troubleshooting;
## Documentation
Welcome PR to further improve English [documentation ](https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/en ).
2020-08-26 11:21:53 +08:00
## Online Tutorials
Please refer to [README.MD at tutorials/katacoda ](tutorials/katacoda/README.md#contribution-guide )
2018-09-26 11:03:13 +08:00
## Developer
2018-10-12 15:01:36 +08:00
* Arthas runtime supports JDK6+
* To build Arthas requires JDK7+, because of the source code import JDK7 classes, such as `java.lang.management.BufferPoolMXBean` .
2018-09-26 11:03:13 +08:00
### Local Installation
Recommend to use [`as-package.sh` ](as-package.sh ) to package, which will auto-install the latest Arthas to local `~/.arthas` and when debugging, Arthas will auto-load the latest version.
F.Y.I
1. when using [`as.sh` ](https://github.com/alibaba/arthas/blob/master/bin/as.sh ) to start Arthas, it will get the latest version under `~/.arthas/lib` ;
2. when [`as-package.sh` ](as-package.sh ) packaging, it will get the version from `pom.xml` and suffix it with the current timestamp e.g. `3.0.5.20180917161808` .
You can also use `./mvnw clean package -DskipTests` to package and generate a `zip` under `packaging/target/` but remember when `as.sh` starts, it load the version under `~/.arthas/lib` .
### Start Arthas in specified version
When there are several different version, you can use `--use-version` to specify the version of Arthas to start your debug.
```bash
./as.sh --use-version 3.0.5.20180919185025
```
Tip: you can use `--versions` to list all available versions.
```bash
./as.sh --versions
```
### Debug
2018-10-12 15:01:36 +08:00
* [Debug Arthas In IDEA ](https://github.com/alibaba/arthas/issues/222 )
2018-09-26 11:03:13 +08:00
### Packaging All
* Arthas is using [Sphinx ](http://www.sphinx-doc.org/en/master/ ) to generate the static site
* `sphinx-maven-plugin` configured in [`site/pom.xml` ](https://github.com/alibaba/arthas/tree/master/site )
* `sphinx-maven-plugin` executes by downloading`sphinx-binary/`
2019-09-09 00:15:46 +08:00
* when packaging the whole project (Packaging All), you need to execute:
2018-09-26 11:03:13 +08:00
```bash
2019-09-09 00:15:46 +08:00
./mvnw clean package -DskipTests -P full
2018-09-26 11:03:13 +08:00
```
---
2018-09-13 00:23:22 +08:00
2020-05-25 20:30:18 +08:00
## Issue
2018-09-13 00:23:22 +08:00
欢迎在issue里对arthas做反馈， ，
* https://github.com/alibaba/arthas/issues
## 改进用户文档
2018-09-19 19:31:12 +08:00
用户文档在`site/src/site/sphinx`目录下， ，
英文文档在`site/src/site/sphinx/en`目录下，
2018-09-13 00:23:22 +08:00
2020-08-26 11:21:53 +08:00
## 改进在线教程
请参考[tutorials/katacoda下的说明](tutorials/katacoda/README_CN.md#贡献指南)
2018-09-13 00:23:22 +08:00
## 开发者相关
2018-10-12 15:01:36 +08:00
* Arthas运行支持JDK6+
2019-02-14 11:45:31 +08:00
* 编译Arthas要求JDK7+，
2018-09-13 00:23:22 +08:00
### 安装到本地
2018-09-17 16:27:41 +08:00
本地开发时，推荐执行`as-package.sh`来打包，
2018-09-13 00:23:22 +08:00
2018-09-17 16:27:41 +08:00
`as.sh` 在启动时，会对`~/.arthas/lib`下面的目录排序，取最新的版本。`as-package.sh`在打包时，会取`pom.xml`里的版本号，再拼接上当前时间，比如： `3.0.5.20180917161808` ，这样子排序时取的就是最新的版本。
2018-12-03 11:48:04 +08:00
也可以直接 `./mvnw clean package -DskipTests` 打包， `packaging/target/` 下面。但是注意`as.sh`启动加载的是`~/.arthas/lib`下面的版本。
2018-09-17 16:27:41 +08:00
2018-09-19 19:31:12 +08:00
### 启动指定版本的arthas
本地开发时，可能会产生多个版本，可以用 `--use-version` 参数来指定版本，比如
```bash
./as.sh --use-version 3.0.5.20180919185025
```
可以用`--versions`参数来列出所有版本：
```bash
./as.sh --versions
```
2018-09-17 16:27:41 +08:00
### Debug
2018-10-12 15:01:36 +08:00
* [Debug Arthas In IDEA ](https://github.com/alibaba/arthas/issues/222 )
2018-09-13 00:23:22 +08:00
### 全量打包
* arthas是用sphinx来生成静态网站
2018-12-07 11:24:05 +08:00
* 在`site/pom.xml`里配置了`sphinx-maven-plugin`
2018-09-13 00:23:22 +08:00
* `sphinx-maven-plugin` 通过下载`sphinx-binary/`来执行
2020-04-10 11:30:42 +08:00
2019-09-09 00:15:46 +08:00
* 全量打包时，需要配置下面的参数：
2018-09-13 00:23:22 +08:00
```
2020-04-10 11:30:42 +08:00
./mvnw clean package -DskipTests -P full
2018-09-13 00:23:22 +08:00
```
2020-04-10 11:30:42 +08:00
#### 当 sphinx-maven-plugin 下载出错时，可以用下面的方式
到 https://github.com/trustin/sphinx-binary/releases 下载对应版本的二进制文件，并在本地加上可执行权限。例如：
```
wget https://github.com/hengyunabc/sphinx-binary/releases/download/v0.4.0.1/sphinx.osx-x86_64 -o /tmp/sphinx.osx-x86_64
chmod +x /tmp/sphinx.osx-x86_64
./mvnw clean package -DskipTests -P full -Dsphinx.binUrl=file:/tmp/sphinx.osx-x86_64
```
2018-09-13 00:23:22 +08:00
2018-12-07 11:24:05 +08:00
### Release Steps
2018-09-13 00:23:22 +08:00
2018-12-07 11:24:05 +08:00
发布release版本流程：
2019-11-26 10:51:38 +08:00
* 修改`as.sh`里的版本，最后修改日期， `Bootstrap.java` 里的版本，
2018-12-07 11:24:05 +08:00
* 修改本地的maven settings.xml
2020-11-04 12:41:09 +08:00
* mvn clean deploy -DskipTests -P full -P release
2019-02-14 14:30:16 +08:00
2020-04-10 11:30:42 +08:00
如果在下载 sphinx-binary 出错，参考上面的 全量打包 的说明。
2019-02-14 14:30:16 +08:00
2018-12-07 11:24:05 +08:00
* 到 https://oss.sonatype.org/ 上， ，
2019-12-05 17:34:59 +08:00
* 发布后，可以到这里查看是否同步到仓库里了： https://repo1.maven.org/maven2/com/taobao/arthas/arthas-packaging/
2019-02-14 14:30:16 +08:00
* 发布完maven仓库之后， ，
2020-06-01 10:52:01 +08:00
比如下载地址： https://maven.aliyun.com/repository/public/com/taobao/arthas/arthas-packaging/3.x.x/arthas-packaging-3.x.x-bin.zip
2020-11-04 12:41:09 +08:00
* 打上tag，
2021-03-17 17:49:21 +08:00
* 需要更新 gh-pages 分支下面的 arthas-boot.jar/math-game.jar/as.sh ，下载 doc.zip，
2019-11-26 10:51:38 +08:00
* 需要更新docker镜像， ： & ordering=last_updated
2019-02-14 14:30:16 +08:00
2019-03-19 10:30:41 +08:00
以 3.1.0 版本为例：
2019-02-14 14:30:16 +08:00
```
2019-03-19 10:30:41 +08:00
docker build . --build-arg ARTHAS_VERSION=3.1.0 -t hengyunabc/arthas:3.1.0
2019-02-14 14:30:16 +08:00
docker tag hengyunabc/arthas:3.1.0 hengyunabc/arthas:latest
docker push hengyunabc/arthas:3.1.0
docker push hengyunabc/arthas:latest
2019-03-19 10:30:41 +08:00
docker build . --build-arg ARTHAS_VERSION=3.1.0 -f Dockerfile-No-Jdk -t hengyunabc/arthas:3.1.0-no-jdk
2019-02-14 14:30:16 +08:00
docker push hengyunabc/arthas:3.1.0-no-jdk
```
2019-09-09 15:50:46 +08:00
* 更新README.md， ， ，
2019-09-19 11:24:37 +08:00
* 更新release页面的 issue信息，
2019-12-05 17:34:59 +08:00
* 更新内部的版本
