.NetCore基于Jenkins和Gogs的自动化部署方案

# Ubuntu
sudo apt-get install git
# CentOS
sudo yum install -y git
# 配置，暂时也可以不配置
git config --global user.name "your name"
git config --global user.email "your email"

[ApiController]
[Route("[controller]")]
public class HomeController : ControllerBase
{
[HttpGet]
public string Get()
{
return "Hello，当前时间：" + DateTime.Now;
}
}

# 创建一个目录，存放项目文件，目录可自定义，比如我这里是/opt/demo
sudo mkdir /opt/demo
# 修改权限，把这个目录所有者给jenkins用户
sudo chown -R jenkins. /opt/demo

# 打开一个service文件
sudo vim /etc/systemd/system/DemoWebApi.service

[Unit]
Description=DemoWebApi(dotnet)[Install]
WantedBy=multi-user.target[Service]
User=root
WorkingDirectory=/opt/demo
ExecStart=/opt/dotnet-sdk-3.1.302-linux-x64/dotnet DemoWebApi.dll --urls=http://0.0.0.0:5050
ExecReload=/bin/kill -HUP $MAINPID
KillMode=process
Restart=always
RestartSec=30s

# 启用
sudo systemctl enable DemoWebApi.service

#!/bin/bash # 这里执行的shell的脚本将使用git pull下来的代码根路径作为当前工作路径来执行脚本，这个路径也就是Jenkins所指的workspace路径，这里切换到.csproj文件所在目录
cd DemoWebApi
# 停止服务单元
sudo systemctl stop DemoWebApi.service
# 使用的是dotnet 3.1，-c Release表示以Release的形式发布项目，发布失败直接退出
/opt/dotnet-sdk-3.1.302-linux-x64/dotnet publish -c Release || exit 1
# 删除旧发布文件
rm -rf /opt/demo/*
# 移动新发布文件到项目文件存放目录
mv bin/Release/netcoreapp3.1/publish/* /opt/demo/
# 启动服务单元
sudo systemctl start DemoWebApi.service

#!/bin/bash # 这里执行的shell的脚本将使用git pull下来的代码根路径作为当前工作路径来执行脚本，这个路径也就是Jenkins所指的workspace路径，这里切换到.csproj文件所在目录
cd DemoWebApi
# 停止并删除容器
sudo docker stop DemoWebApi && sudo docker rm DemoWebApi
# 使用的是dotnet 3.1，-c Release表示以Release的形式发布项目，发布失败直接退出
/opt/dotnet-sdk-3.1.302-linux-x64/dotnet publish -c Release || exit 1
# 删除旧发布文件
rm -rf /opt/demo/*
# 移动新发布文件到项目存放目录
mv bin/Release/netcoreapp3.1/publish/* /opt/demo/
# 创建并启动容器，注意，这里项目在容器中启动端口是5000，使用-p在宿主机和容器做了一个端口映射
sudo docker run -d --name DemoWebApi -p 5050:5000 -w /opt/demo -v /opt/demo:/opt/demo dotnetcore:v3.1 dotnet DemoWebApi.dll --urls=http://0.0.0.0:5000

# 创建docker-compose.yml
sudo vim /opt/demo/docker-compose.yml
# 修改权限，把所有者给jenkins用户
sudo chown -R jenkins. /opt/demo/docker-compose.yml

version: '2'
services:
api:
image: dotnetcore:v3.1
container_name: DemoWebApi
volumes:
- /opt/demo:/opt/demo
expose:
- 5000
restart: always
working_dir: /opt/demo
ports:
- 5050:5000
command: dotnet DemoWebApi.dll --urls=http://0.0.0.0:5000

#!/bin/bash # 这里执行的shell的脚本将使用git pull下来的代码根路径作为当前工作路径来执行脚本，这个路径也就是Jenkins所指的workspace路径，这里切换到.csproj文件所在目录
cd DemoWebApi
# down，--project-directory是docker-compose项目生成目录，-f是指定docker-compose.yml
sudo docker-compose --project-directory /opt/demo -f /opt/demo/docker-compose.yml down
# 使用的是dotnet 3.1，-c Release表示以Release的形式发布项目，发布失败直接退出
/opt/dotnet-sdk-3.1.302-linux-x64/dotnet publish -c Release || exit 1
# 删除旧发布文件
find /opt/demo/* | grep -v docker-compose.yml | xargs sudo rm -rf
# 移动新发布文件到项目存放目录
mv bin/Release/netcoreapp3.1/publish/* /opt/demo/
# up，--project-directory是docker-compose项目生成目录，-f是指定docker-compose.yml
sudo docker-compose --project-directory /opt/demo -f /opt/demo/docker-compose.yml up -d

[ApiController]
[Route("[controller]")]
public class HomeController : ControllerBase
{
[HttpGet]
public string Get()
{
return "Hello，这是修改后的当前时间：" + DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss");
}
}

# 重启
sudo systemctl restart jenkins.service

Passphrase：私钥的秘钥，在生成SSH Key的时候可以设置一个秘钥，就是Passphrase，如果不设置，此项可以置为空
Path to key：私钥文件的路径，可以是绝对路径，也可以是基于$JENKINS_HOME的相对路径
Key：私钥，也就是私钥文件的内容，Key和Path to key应该至少设置一个，如果都设置，Key将优先使用

Name：连接名称，随便取
Hostname：SSH连接使用的地址，可以是Hostname，也可以是IP
Username：SSH连接使用的用户，要求将上面配置的私钥对应的公钥信息追加到这个用户所在主目录下的.ssh目录下的authorized_keys文件中，为避免出现不必要的权限问题，建议使用root用户
Remote Directory：远程服务器上的一个目录地址，必须是已存在的，SSH连接只会将会将文件发送保存到这个目录下，同时保证上面的Username用户对这个目录有操作权限
高级：像端口等其它设置在高级里面
Test Configuration：测试SSH Server配置是否正确，建议配置完成后测试一遍

#!/bin/bash # 这里执行的shell的脚本将使用git pull下来的代码根路径作为当前工作路径来执行脚本，这个路径也就是Jenkins所指的workspace路径，这里切换到.csproj文件所在目录
cd DemoWebApi
# 使用的是dotnet 3.1，-c Release表示以Release的形式发布项目，发布失败直接退出
/opt/dotnet-sdk-3.1.302-linux-x64/dotnet publish -c Release || exit 1
# 如果上次包文件存在，则删除
if [ -f ./publish.tar.gz ];then
rm -f ./publish.tar.gz
fi
# 将发布文件打包
tar -zcf publish.tar.gz -C bin/Release/netcoreapp3.1 publish

#!/bin/bash # 注意，命令执行的目录是用户根目录，所以建议切换目录或者使用绝对路径
cd /opt/jenkins/DemoWebApi
# 文件解压
tar -zxf publish.tar.gz
# 停止服务单元
systemctl stop DemoWebApi.service
# 删除旧发布文件
rm -rf /opt/demo/*
# 移动新发布文件到项目文件存放目录
mv /opt/jenkins/DemoWebApi/publish/* /opt/demo/
# 启动服务单元
systemctl start DemoWebApi.service
# 清空当前目录文件
rm -rf ./*

SSH Server：即上面我们创建的服务器连接配置
Transfer：即往SSH Server发送文件或者执行命令的设置集合set，每个set设置如下：
Source file：要往SSH Server发送的文件，多个文件之间默认使用逗号(,)分隔，注意，这是文件不是目录，如果有多个文件及目录，可以使用tar打包，发送过去后再解压，比如我这里打包publish.tar.gz
Remote directory：SSH Server上存放这个文件的目录，如果不存在会自动创建，注意，这个目录是相对上面【系统管理】=》【系统配置】中配置的SSH Server的Remote directory目录的，比如我这边Source files会保存在/opt/jenkins/DemoWebApi/目录下
Remove prefix：移除前缀，一般是Source files的目录部分，比如我这里如果不设置前缀，那么我上面的Source files将会放到/opt/jenkins/DemoWebApi/DemoWebApi/目录下，因为我的Source files前面还有一节路径DemoWebApi，如果我这里设置了前缀DemoWebApi，因此会将Source files放到/opt/jenkins/DemoWebApi目录下
Exec command：发送SSH Server执行的命令，注意，命令执行的目录是用户主目录，不是Remote directory，所以建议命令使用到的路径采用绝对路径

1、点击立即构建开始构建
2、Jenkins从gogs获取代码更新
3、执行【构建环境】中的【Send files or execute commands over SSH before the build starts】操作（这里没使用到）
4、执行【构建】，即执行shell脚本，我这里是发布项目，并将发布文件打包成tar包
5、执行【构建环境】中的【Send files or execute commands over SSH after the build runs】操作（这里没使用到）
6、执行【构建后操作】，我使用的是【Send build artifacts over SSH】，先发送Source files，然后执行Command脚本，脚本内容就是解压，并将发布文件更新，再重新启动服务
7、构建完成

[ApiController]
[Route("[controller]")]
public class HomeController : ControllerBase
{
[HttpGet]
public string Get()
{
return "Hello，这是本次修改后将自动构建，当前时间：" + DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss");
}
}