DockerHub開啟付費功能后,自動構建的功能不再免費開放了,這樣Github的項目就不能再免費自動構建docker鏡像並自動發布到DockerHub上。
前言
這里記錄下使用 GitHub Actions持續集成服務自動構建發布鏡像到DockerHub,目前GitHub Actions是免費開放的,所以Github上的項目都可以使用它來發布、測試、部署等等,非常方便。Github Actions 官方文檔
配置
首先在項目中創建目錄 .github/workflows
, 然后在該目錄中新建一個 .yml
文件,這里命名為 docker-image.yml
。 文件的名字沒有實際意思,一個文件代表一個workflow任務。
文件內容如下(文件中#
開頭的為注釋,是為方便理解加上去的):
# docker-image.yml
name: Publish Docker image # workflow名稱,可以在Github項目主頁的【Actions】中看到所有的workflow
on: # 配置觸發workflow的事件
push:
branches: # master分支有push時觸發此workflow
- 'master'
tags: # tag更新時觸發此workflow
- '*'
jobs: # workflow中的job
push_to_registry: # job的名字
name: Push Docker image to Docker Hub
runs-on: ubuntu-latest # job運行的基礎環境
steps: # 一個job由一個或多個step組成
- name: Check out the repo
uses: actions/checkout@v2 # 官方的action,獲取代碼
- name: Log in to Docker Hub
uses: docker/login-action@v1 # 三方的action操作, 執行docker login
with:
username: ${{ secrets.DOCKERHUB_USERNAME }} # 配置dockerhub的認證,在Github項目主頁 【Settings】 -> 【Secrets】 添加對應變量
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@v3 # 抽取項目信息,主要是鏡像的tag
with:
images: jhao104/proxy_pool
- name: Build and push Docker image
uses: docker/build-push-action@v2 # docker build & push
with:
context: .
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
配置中大部分我都加上了注釋,需要特別說明的是 steps
中的 uses
。 我們以第二個step Log in to Docker Hub
為例,正常情況下,我們應該是運行 run docker login **
。
這里使用了一個 action docker/login-action,action 其實就是一系列step的組成,所以既然別人已經做好了,干嘛不直接用呢。所有可用的 action可以到 這里 查找。
使用
配置妥當之后,提交代碼推送至github。按照本例中的配置,只要master分支有push事件或者tag有更新,就會觸發Github Action,然后自動構建鏡像推送至DockerHub。
可以在Github項目主頁的【Actions】欄中查看每次執行詳情,例如:
可以點擊每一個step查看輸出日志。
上面的配置注意兩個部分,一是step 2的Dockerhub認證配置,你需要將你的Dockerhub用戶名和Token(在Dockerhub頁面生成)配置為Github項目主頁的 【Settings】 -> 【Secrets】的變量。
二是,step 3中將images
的名字改為你自己的,鏡像的tag會自動抽取,默認情況下,如果是分支,鏡像tag則為分支名,如果為github tag 則會推送 tag 和 latest
兩個鏡像,具體配置參見 docker-metadata-action 。
轉載請注明來源