GitHub Actions

前言 之前写了一个开源项目，每次打tag的时候都要手动构建docker image然后上传实在是太麻烦了。于是研究了下GitHub Actions，发现非常好用。 本文就来讲一下，如何借助 Github Actions 自动构建兼容多 CPU 架构的 docker 镜像并发布到 DockerHub。 配置 使用build-push-action进行实现多CPU架构镜像构建。按照官方文档可以快速使用起来，但是有几个比较容易出错的地方需要注意。 配置案例 创建配置文件.github/workflows/docker-publish.yml name: Docker # This workflow uses actions that are not certified by GitHub. # They are provided by a third-party and are governed by # separate terms of service, privacy policy, and support # documentation. on: push: # Publish semver tags as releases. tags: [ '**' ] env: # Use docker.io for Docker Hub if empty REGISTRY: 'docker.io' # github.repository as <account>/<repo> IMAGE_NAME: ${{ github.repository }} jobs: build: runs-on: ubuntu-latest permissions: contents: read packages: write # This is used to complete the identity challenge # with sigstore/fulcio when running outside of PRs. id-token: write steps: - name: Checkout repository uses: actions/checkout@v4 # Install the cosign tool except on PR # https://github.com/sigstore/cosign-installer - name: Install cosign uses: sigstore/[email protected] with: cosign-release: 'v2.4.0' # Set up BuildKit Docker container builder to be able to build # multi-platform images and export cache # https://github.com/docker/setup-buildx-action - name: Set up Docker Buildx uses: docker/setup-buildx-action@v3 # Login against a Docker registry except on PR # https://github.com/docker/login-action - name: Log into registry ${{ env.REGISTRY }} uses: docker/login-action@v3 with: registry: ${{ env.REGISTRY }} username: ${{ secrets.DOCKERHUB_USERNAME }} password: ${{ secrets.DOCKERHUB_TOKEN }} # Extract metadata (tags, labels) for Docker # https://github.com/docker/metadata-action - name: Extract Docker metadata id: meta uses: docker/metadata-action@v5 with: images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} # Build and push Docker image with Buildx (don't push on PR) # https://github.com/docker/build-push-action - name: Build and push Docker image id: build-and-push uses: docker/build-push-action@v6 with: context: . platforms: linux/amd64,linux/arm64 push: true tags: ${{ steps.meta.outputs.tags }} labels: ${{ steps.meta.outputs.labels }} 很多配置见名知意，对照官方文档也都能找到答案。有的版本官方案例中使用很长一串具体版本，为了方便使用，我改为了数字版本。 ...

前言 简单记录下使用使用GitHub Actions自动构建程序并发布到Release。摸索了好一阵，坑还比较多。 配置 配置主要分为构建和上传。这里使用python作为示例，为了能在其他语言复用这个模板，这里尽量配置得通用一点。 构建部分参考Building and testing Python。上传部分参考了多个开源项目，并且实践修改而来。 配置案例 创建配置文件.github/workflows/python-package.yml name: Python package on: push: tags: [ '**' ] jobs: Linux-build-amd64: name: Build Linux Amd64 runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - uses: actions/setup-python@v5 with: # 必须加'' python-version: '3.10' - name: Install dependencies run: | python -m pip install --upgrade pip pip install wheel pyinstaller if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - name: Pyinstaller run: | pyinstaller --onefile --add-data "conf.yaml.default:." --add-data "templates:templates" --name vpspeek app.py - name: Verify generated file run: | ls -l dist/ - name: Upload Linux File uses: actions/upload-artifact@v3 with: path: dist/vpspeek Create-release: permissions: write-all runs-on: ubuntu-latest needs: [ Linux-build-amd64 ] steps: - name: Download Linux File uses: actions/download-artifact@v3 with: path: dist/ - name: Move downloaded file run: | mv dist/artifact/* dist/ - name: Verify file after move run: | ls dist/ - name: Create Release id: create_release uses: actions/create-release@v1 env: GITHUB_TOKEN: ${{ secrets.MY_GITHUB_TOKEN }} with: tag_name: ${{ github.ref }} release_name: Release ${{ github.ref }} draft: false prerelease: false - name: Upload Release Asset uses: actions/upload-release-asset@v1 env: GITHUB_TOKEN: ${{ secrets.MY_GITHUB_TOKEN }} with: upload_url: ${{ steps.create_release.outputs.upload_url }} asset_path: dist/vpspeek asset_name: vpspeek asset_content_type: application/octet-stream 配置说明 on.push.tags: [ '**' ]每次打tag的时候都自动构建。 jobs 分为 Linux-build-amd64 和 Create-release ，方便后面对 Windows 或者其他版本系统进行扩展。 actions/setup-python@v5 的 python-version: ‘3.10’ 必须使用’’。如填3.10会被识别成3.1。 actions/download-artifact@v3 下载步骤，会在下载的目录中为每个 artifact 创建一个子目录，默认情况下这个子目录的名称会是 artifact 名称（即 artifact）。这样就导致了期望文件 vpspeek 出现在 dist/ 目录下，实际上它在 dist/artifact/ 目录中。 解决办法就是把文件mv到dist或者直接使用artifact下的文件。 GitHub不允许配置GITHUB_开头的secrets，MY_GITHUB_TOKEN。