Merge pull request #116 from weseek/support/add-release-workflow-and-update-documents

リリース workflow の追加と Update.md の更新

Author: kouki-o

.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: Release
+
+on:
+  push:
+    tags:
+    - '*'
+      
+
+env:
+  IMAGE_NAME: weseek/docker-jenkins
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_REGISTRY_USERNAME }}
+          password: ${{ secrets.DOCKER_REGISTRY_PASSWORD }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          platforms: linux/amd64
+          push: true
+          tags: |
+            weseek/${{ env.IMAGE_NAME }}:${{ github.ref_name }}
+            weseek/${{ env.IMAGE_NAME }}:${{ github.sha }}

Dockerfile

@@ -1,5 +1,5 @@
 FROM jenkins/jenkins:2.492.3-lts
-MAINTAINER Yusuke Takagi <[email protected]> 
+MAINTAINER Koki Oyatsu <[email protected]>
 
 ARG user=jenkins
 ENV DEBIAN_FRONTEND noninteractive

README.md

@@ -1,13 +1,15 @@
 # docker-jenkins
 
-## Startup
+## image の使い方
 
 ### docker インストール
-`公式サイトを参照`  
+公式サイトを参照
+
 https://docs.docker.com/engine/installation/linux/
 
 ### docker-compose インストール
-`公式サイトを参照`  
+公式サイトを参照
+
 https://docs.docker.com/compose/install/
 
 ### systemctl 起動コマンドの設定

Update.md

@@ -1,69 +1,43 @@
-# イメージで使う Jenkins のアップデート方法
-
-## weseek/docker-jenkins
-githubに管理されているリポジトリからクローン。  
-https://github.com/weseek/docker-jenkins.git
-
-## jenkins のアップデート方法
-git クローン後、ディレクトリ直下にあるDockerfileを修正する。  
-`「FROM jenkins:X.XX.X」の部分を修正。`
-
-最新バージョンはdocker-hubの公式イメージから参照する。  
-https://hub.docker.com/r/_/jenkins/
-
-``` Dockerfile
-FROM jenkins:2.32.2
-USER root
-ARG user=jenkins
-
-# chrome
-RUN wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add -
-RUN sh -c 'echo "deb http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
-
-# apt install && update
-RUN apt-get update && apt-get install -y google-chrome-stable xvfb sudo fonts-vlgothic
-RUN apt-get clean && rm -rf /var/lib/apt/lists/*
-
-#font
-RUN mkdir -p /usr/lib/jvm/java-8-openjdk-amd64/jre/font/fallback
-RUN ln -s /usr/share/fonts/truetype/vlgothic/VL-PGothic-Regular.ttf /usr/lib/jvm/java-8-openjdk-amd64/jre/font/fallback/
-
-# sudo
-RUN sed -i -e 's/%sudo\s*ALL=(ALL:ALL)\sALL/%sudo   ALL=(ALL:ALL) NOPASSWD: ALL/g' /etc/sudoers
-RUN usermod -aG sudo ${user}
-
-# jenkins plugin
-USER ${user}
-COPY plugins.txt /usr/share/jenkins/plugins.txt
-RUN /usr/local/bin/plugins.sh /usr/share/jenkins/plugins.txt
-```
-
-## docker-jenkins イメージの更新
-Dockerfile又はplugins.txtファイルを書き換え後、リポジトリにpushを行う。  
-`尚pushの際には、コミットにタグを必ず付加する。`
-
-### git コミットにタグを追加する方法
-https://git-scm.com/book/ja/v1/Git-%E3%81%AE%E5%9F%BA%E6%9C%AC-%E3%82%BF%E3%82%B
-
-`コミットタグは、jenkinsLTSのバージョンに追従すること`  
-jenkinsLTSのバージョンが2.32.2の場合、コミットタグは「2.32.2」と入力する。
-
-push後、下記のURLからイメージが更新されたことを確認。  
-https://hub.docker.com/r/weseek/docker-jenkins/~/dockerfile/
-
-## dockerコンテナの更新
-管理されているホストにログインし、下記コマンドを実行して最新イメージをpull。
-
-```
-$ docker pull  weseek/docker-jenkins
-```
-dockerイメージ更新後、下記コマンド実行して、既存コンテナを削除。
-```
-$ docker rm jenkins_app_1 -f
-```
-
-下記コマンドを実行し、コンテナを新規作成する。
-```
-$ sudo systemctl start [email protected]
-```
-ホスト上のjenkinsにアクセスし、アップデートされたことを確認する。
+# イメージで使う Jenkins のアップデート方法
+
+1. リポジトリをクローン
+    - https://github.com/weseek/docker-jenkins.git
+1. git クローン後、ディレクトリ直下にあるDockerfileを修正する
+    - 「FROM jenkins:X.XX.X」の部分を修正
+    - 最新バージョンはdocker-hubの公式イメージから参照する
+        - https://hub.docker.com/r/_/jenkins/
+
+``` Dockerfile
+FROM jenkins:2.32.2
+```
+
+## docker-jenkins イメージの更新
+- Dockerfile又はplugins.txtファイルを書き換え後、リポジトリにpushを行う
+- tag が push されたことを検知して GitHub Actions の release workflow が起動するようになっている
+    - `.github/workflows/release.yml` を参考にすること
+
+### git コミットにタグを追加する方法
+- タグ名は、jenkinsLTSのバージョンに追従すること
+- jenkinsLTSのバージョンが2.32.2の場合、コミットタグは「2.32.2」と入力する
+    - 同じバージョンで複数のタグを打ちたい場合には 2.32.2-1 とする
+- push後、下記のURLからイメージが更新されたことを確認
+    - https://hub.docker.com/r/weseek/docker-jenkins/~/dockerfile/
+
+## dockerコンテナの更新
+管理されているホストにログインし、下記コマンドを実行して最新イメージをpull
+
+```
+$ docker pull  weseek/docker-jenkins
+```
+
+dockerイメージ更新後、下記コマンド実行して、既存コンテナを削除
+```
+$ docker rm jenkins_app_1 -f
+```
+
+下記コマンドを実行し、コンテナを新規作成する
+```
+$ sudo systemctl start [email protected]
+```
+
+ホスト上のjenkinsにアクセスし、アップデートされたことを確認する