首页 > 解决方案 > 如何使用markdown从gitlab CI中的文件中使用release API进行描述

问题描述

我在 gitlab-ci.yml 中使用 Gitlab 发布 API,以便能够在部署时自动创建新版本。

只需在文档中放置一个像这里这样的 curl 请求就可以了。对于描述,文档声明允许降价,这很好。但是,我似乎无法弄清楚或想出从 curl 请求中的降价文件加载描述的想法。我已经尝试在 curl 之前将 markdown 文件的内容存储在 gitlab-ci.yml 中的变量中,然后将其传递并在 curl 中展开,如下所示:

# gitlab-ci.yml
...
- DESCRIPTION=`cat ./description.md`

并且也只是将cat ./description.mdcurl 请求本身作为“描述”的值。

这是文档中的示例:

curl --header 'Content-Type: application/json' --header "PRIVATE-TOKEN: gDybLx3yrUK_HLp3qPjS" \
     --data '{ "name": "New release", "tag_name": "v0.3", "description": "Super nice release", "milestones": ["v1.0", "v1.0-rc"], "assets": { "links": [{ "name": "hoge", "url": "https://google.com" }] } }' \
     --request POST https://gitlab.example.com/api/v4/projects/24/releases

对于“描述”键,我想将降价文件的内容作为值传递。

我很惊讶还没有找到关于这个的帖子或讨论,所以我怀疑我要么遗漏了一些东西(非常基本/显而易见),要么人们还没有真正使用这个功能?

任何帮助都感激不尽。

标签: apicontinuous-integrationgitlabmarkdownrelease

解决方案


使用像你这样的变量,这.gitlab-ci.yml有效:

create_release:
    script:
      - DESCRIPTION=$(cat description.md)
      - |
        curl --silent --request POST --header "Content-Type:application/json" \ 
        --header "PRIVATE-TOKEN: TOKEN" \ 
        --data '{"name":"New release","tag_name":"v0.3", "description":"'"$DESCRIPTION"'","assets":{"links":[{"name":"hoge","url":"https://google.com"}]}}' \
        https://gitlab.bankassembly.com/api/v4/projects/369/releases

该变量在双引号内展开(参见https://superuser.com/a/835589

我的内容示例description.md

## CHANGELOG\r\n\r\n- Escape label and milestone titles to prevent XSS in GFM autocomplete. !2740\r\n- Prevent private snippets from being embeddable.\r\n- Add subresources removal to member destroy service.

推荐阅读