牧云主机助手目前默认仅免费三台主机，超过三台主机的使用量时，需要切换付费版本。 也可以不切换，但是三台以上的机器无法成功注册。

1. 注册百川-使用牧云主机管理助手

2. 点击绑定主机

3. 获取token

为了方便，可以选择长期使用的token

4. 在github创建一个空的仓库，clone到本地，并创建.github/workflows/workflow.yml文件，写入一下参考内容：

name: example
on: [ push, pull_request ]

jobs:
  runner:
    runs-on: ubuntu-latest # 选择你想要的主机系统如：ubuntu:20.04
    steps:
      - uses: actions/checkout@v3
      - name: collie
        uses: dvkunion/CollieTrickster@main
        with:
          token: xxxxxx  # your token,  It will be safer to use ${{ secrets.token }}, see [https://docs.github.com/actions/security-guides/encrypted-secrets] 

5. 推送代码到仓库，触发action。

git push

6. 返回百川界面，已获取到主机。

7. 后续使用时可以通过手动触发action的方式。

8. 关于退出：Linux主机，在百川解绑主机后，ci自动完成。

注意：这种方式在ci页面会暴露你的牧云助手token信息！请确保不要使用长期token的模式，
重要的事重复一遍！请使用一次性安装的token！ 不要使用长期token！

每次推送代码才能触发实在太蠢了。当然也十分的不够优雅，需要手动把token放在github secrets中。

在基础用法的基础上，这里给出一份通过workflow_dispatch 利用方式:

name: example
on:
  workflow_dispatch:
    inputs:
      token:
        description: 'chaitin rivers token'
        required: true
      type:
        description: 'your host type'
        required: true

jobs:
  runner:
    runs-on: ubuntu-latest # 选择你想要的主机系统如：ubuntu:20.04
    steps:
      - uses: actions/checkout@v3
      - name: collie
        if: ${{ inputs.token != '' && inputs.type != '' }}
        uses: dvkunion/CollieTrickster@main
        with:
          token: ${{ inputs.token }}
          host_type: ${{ inputs.type }}

使用时，需要你生成一个 Github Token ，作为认证用；

然后将这份yaml放在你的仓库.github/workflows/example.yml，或者直接fork本仓库也可以。

最后发起一个http请求, 这里给出一个curl的调用:

curl \     
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR_GITHUB_ACTION>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/<YOUR_GITHUB_USER_NAME>/<YOUR_GITHUB_REPOS>/actions/workflows/example.yml/dispatches \
  -d '{"ref":"main","inputs":{"token":"<YOUR_TOKEN>","type": "linux"}'

其中:

• <YOUR_GITHUB_ACTION>: github配置的token认证
• <YOUR_GITHUB_USER_NAME>: 你github账户名称
• <YOUR_GITHUB_REPOS>: 你fork的仓库名，一般直接fork的就写CollieTrickster即可。
• <YOUR_TOKEN>: 长亭牧云主机助手生成的那个Token。

这样，每发起一次请求，就会执行一次CI。成功上线一台主机。

url为 https://api.github.com/repos/<YOUR_GITHUB_USER_NAME>/<YOUR_GITHUB_REPOS>/actions/workflows/example.yml/dispatches 时
触发的对象为 <YOUR_GITHUB_USER_NAME>/<YOUR_GITHUB_REPOS>/actions/workflows/example.yml
如果是fork的仓库，这份yaml默认为linux主机脚本

想使用windows时， 对应的yaml脚本为：<YOUR_GITHUB_USER_NAME>/<YOUR_GITHUB_REPOS>/actions/workflows/example_windows.yml
同时在http请求里， 替换请求体的json参数： '{"ref":"main","inputs":{"token":"<YOUR_TOKEN>","type": "windows"}'