Skip to main content

CI/CD tool of Chongqing Parsec Corp.

Project description

一、如何使用arms?

使用--help命令熟悉arms:

(venv311) ➜  ~ arms --help
usage: arms [-h] {version,init,patch,config,search,update,design} ...

armstrong

positional arguments:
  {version,init,patch,config,search,update,design}
    version             显示版本
    init                项目初始化工具
    patch               项目补丁工具
    config              arms配置工具
    search              项目搜索工具
    update              arms更新配置
    design              生成文本并复制

options:
  -h, --help            show this help message and exit

第一步:配置arms

arms config ${PARSEC_GITLAB}/arms-tpl/source

第二步:搜索项目

对于kotlin项目,可以尝试:

(venv311) ➜  ~ arms search kotlin
spring-kotlin - kotlin on springboot with CI
kotlin-user - kotlin, 带用户体系

第三步:生成初始化代码

根据上一步的搜索接口,先cd到新创建的项目目录,执行:

git init  # 如果目录下已经用.git目录则忽略
arms init kotlin-user

二、如何创建模版项目

以kotlin-user项目为例,在其项目根目录创建一个.arms.json文件,内容为:

{
  "__name__": [
    {"word": "grpn", "hint": "组名称"}
  ],
  ".env": {
    "ARMS_PROJECT_NAME": "demo"
  }
}

然后在arms init ...的时候arms就会要求用户输入「组名称」和「服务名称」,用于“智能地”替换"grpn"和"demo"。

arms也支持多级配置,例如下面这个前端CI模版的.arms.json文件:

{
    "管理端": {
        "__name__": [{"word": "grpn", "hint": "组名称"}],
        "__only__": ["docker", ".gitlab-ci.yml"]
    },
    "H5端": {
        "__name__": [{"word": "grpn", "hint": "组名称"}],
        "__only__": ["docker", ".gitlab-ci.yml:.gitlab-ci.mobile.yml"]
    },
    ".env": {
        "ARMS_PROJECT_NAME": "demo"
    }
}

关键字列表

__name__: [{}]  //依次提示用户输入
__only__: [""]  //只包含的文件,支持改名
__except__: [""]  //排除的文件

三、如何使用patch功能

patch功能可以把生成的内容打印到标准输入,用户可以把内容作为上下文,跟prompt一起提交给LLM,从而提升LLM结果的质量。

四、友情项目

  • inky-flow-cli: ${PARSEC_GITLAB}/inky/flow_cli ,用于后端项目启动阶段,目标是生成openapi.json。

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arms-1.10.1.tar.gz (21.0 kB view details)

Uploaded Source

Built Distribution

arms-1.10.1-py3-none-any.whl (22.1 kB view details)

Uploaded Python 3

File details

Details for the file arms-1.10.1.tar.gz.

File metadata

  • Download URL: arms-1.10.1.tar.gz
  • Upload date:
  • Size: 21.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.8

File hashes

Hashes for arms-1.10.1.tar.gz
Algorithm Hash digest
SHA256 6e1f0720877cf5f5d5c76e126a49a216f4cc327593fcc59e7b972ad981216559
MD5 d0daf1523f26e0fe0801371dea34a0ed
BLAKE2b-256 ad31ad1b0596aca91b8ca0afa8f484ce14cd56aacc712bf5542d8330ea4c2181

See more details on using hashes here.

File details

Details for the file arms-1.10.1-py3-none-any.whl.

File metadata

  • Download URL: arms-1.10.1-py3-none-any.whl
  • Upload date:
  • Size: 22.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.8

File hashes

Hashes for arms-1.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c514f25737f54e081db43c97ec883357bf31e3c403955f38e12242fd92b17091
MD5 cb1f1dfdda4cf8c754939fee1addb051
BLAKE2b-256 516b0df50d40b368eb426ca6917a2184a78fdec9a8892a9d7fe5f46102d4cca2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page