add actions and devcontainer (#10)

Reviewed-on: #10

.gitea/workflows/mengningsoftware-docs-ci-cd.yaml

@@ -1,79 +1,77 @@
-name: CI/CD Pipeline for mengning.com.cn
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
- 
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    container:
-      image: gitea/runner-images:ubuntu-latest
-    steps:
-      - name: 拉取代码
-        uses: https://devstar.cn/actions/checkout@v4
-        with:
-          fetch-depth: 0  
- 
-      - name: 安装依赖
-        working-directory: 
-        run: |
-            npm install
-            npm add -D vitepress
- 
-      - name: 构建项目
-        working-directory: 
-        run: |
-            chmod +x node_modules/.bin/vitepress
-            npm run build
- 
-      - name: 构建 Docker 镜像
-        run: |
-          docker build -t devstar-docs:${{ gitea.sha }} .
- 
-      - name: 登录 Docker Registry 并推送镜像
-        run: |
-          echo "${{ secrets.DOCKER_REGISTRY_PASSWORD }}" | docker login -u ${{ secrets.DOCKER_REGISTRY_USERNAME }} ${{ vars.DOCKER_REGISTRY_ADDRESS }} --password-stdin
-          docker tag devstar-docs:${{ gitea.sha }} ${{ vars.DOCKER_REGISTRY_ADDRESS }}/${{ vars.DOCKER_REPOSITORY_ARTIFACT}}:${{ gitea.sha }}
-          docker tag devstar-docs:${{ gitea.sha }} ${{ vars.DOCKER_REGISTRY_ADDRESS }}/${{ vars.DOCKER_REPOSITORY_ARTIFACT}}:latest
-          docker push ${{ vars.DOCKER_REGISTRY_ADDRESS }}/${{ vars.DOCKER_REPOSITORY_ARTIFACT}}:${{ gitea.sha }}
-          docker push ${{ vars.DOCKER_REGISTRY_ADDRESS }}/${{ vars.DOCKER_REPOSITORY_ARTIFACT}}:latest    
-
-      - name: 📝 Update mengning.com.cn（通过删除/创建 Application CRD）
-        env:
-          DOCKER_REGISTRY_ADDRESS: ${{ vars.DOCKER_REGISTRY_ADDRESS }}
-          DOCKER_REPOSITORY_ARTIFACT: ${{ vars.DOCKER_REPOSITORY_ARTIFACT }}
-          DOCKER_IMAGE_TAG: ${{ gitea.sha }}
-          TLS_CERTIFICATE: ${{ secrets.TLS_CERTIFICATE }}
-          TLS_PRIVATE_KEY: ${{ secrets.TLS_PRIVATE_KEY }}
-        run: |
-          curl -LO https://mirrors.ustc.edu.cn/kubernetes/core%3A/stable%3A/v1.28/deb/amd64/kubectl_1.28.0-1.1_amd64.deb
-          sudo dpkg -i kubectl_1.28.0-1.1_amd64.deb
-          kubectl config set-cluster remote-cluster --server=${{ secrets.K8S_URL }} --insecure-skip-tls-verify=true
-          kubectl config set-credentials token-user --token=${{ secrets.K8S_TOKEN }}
-          kubectl config set-context remote-context --cluster=remote-cluster --user=token-user
-          kubectl config use-context remote-context
-
-          # 创建或更新 TLS Secret
-          # Secret 名称: mengningsoftware-tls
-          echo "$TLS_CERTIFICATE" > /tmp/tls.crt
-          echo "$TLS_PRIVATE_KEY" > /tmp/tls.key
-          kubectl create secret tls mengningsoftware-tls \
-            --cert=/tmp/tls.crt \
-            --key=/tmp/tls.key \
-            -n istio-system \
-            --dry-run=client -o yaml | kubectl apply -f -
-          rm -f /tmp/tls.crt /tmp/tls.key
-
-          # 替换 Application YAML 中的镜像地址变量并应用
-          sed "s|\${DOCKER_REGISTRY_ADDRESS}|${DOCKER_REGISTRY_ADDRESS}|g; s|\${DOCKER_REPOSITORY_ARTIFACT}|${DOCKER_REPOSITORY_ARTIFACT}|g; s|\${DOCKER_IMAGE_TAG}|${DOCKER_IMAGE_TAG}|g" \
-            .gitea/workflows/application.yaml > /tmp/application-crd.yaml
-
-          # 删除旧的 Application CRD（如果存在，忽略错误）
-          kubectl delete application mengningsoftware -n web-servers --ignore-not-found=true || true
-
-          # 创建新的 Application CRD
-          kubectl apply -f /tmp/application-crd.yaml
+name: CI/CD Pipeline for mengning.com.cn
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+ 
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    # container:
+    #   image: gitea/runner-images:ubuntu-latest
+    steps:
+      - name: 拉取代码
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1  
+ 
+      - name: 安装依赖
+        working-directory: 
+        run: |
+            npm install
+            npm add -D vitepress
+ 
+      - name: 构建项目
+        working-directory: 
+        run: |
+            chmod +x node_modules/.bin/vitepress
+            npm run build
+ 
+      - name: 构建 Docker 镜像
+        run: |
+          docker build -t devstar.cn/devstar/devstar-docs:latest .
+ 
+      - name: 登录 Docker Registry 并推送镜像
+        if: github.event_name != 'pull_request'
+        run: |
+          echo "${{ secrets.DOCKER_REGISTRY_PASSWORD }}" | docker login -u ${{ secrets.DOCKER_REGISTRY_USERNAME }} ${{ vars.DOCKER_REGISTRY_ADDRESS }} --password-stdin
+          docker push devstar.cn/devstar/devstar-docs:latest    
+
+      - name: 📝 Update mengning.com.cn（通过删除/创建 Application CRD）
+        if: github.event_name != 'pull_request'
+        env:
+          TLS_CERTIFICATE: ${{ secrets.TLS_CERTIFICATE }}
+          TLS_PRIVATE_KEY: ${{ secrets.TLS_PRIVATE_KEY }}
+        run: |
+          curl -LO https://mirrors.ustc.edu.cn/kubernetes/core%3A/stable%3A/v1.28/deb/amd64/kubectl_1.28.0-1.1_amd64.deb
+          sudo dpkg -i kubectl_1.28.0-1.1_amd64.deb
+          kubectl config set-cluster remote-cluster --server=${{ secrets.K8S_URL }} --insecure-skip-tls-verify=true
+          kubectl config set-credentials token-user --token=${{ secrets.K8S_TOKEN }}
+          kubectl config set-context remote-context --cluster=remote-cluster --user=token-user
+          kubectl config use-context remote-context
+
+          # 创建或更新 TLS Secret
+          # Secret 名称: mengningsoftware-tls
+          echo "$TLS_CERTIFICATE" > /tmp/tls.crt
+          echo "$TLS_PRIVATE_KEY" > /tmp/tls.key
+          kubectl create secret tls mengningsoftware-tls \
+            --cert=/tmp/tls.crt \
+            --key=/tmp/tls.key \
+            -n istio-system \
+            --dry-run=client -o yaml | kubectl apply -f -
+          rm -f /tmp/tls.crt /tmp/tls.key
+
+          # 删除旧的 Application CRD（如果存在，忽略错误）
+          kubectl delete application mengningsoftware -n web-servers --ignore-not-found=true || true
+
+          # 创建新的 Application CRD
+          kubectl apply -f deploy.yaml
+
+       - name: Clean Environment
+          if: always() 
+          run: |
+            docker rmi devstar.cn/devstar/devstar-docs:latest || true
+            docker builder prune -f  || true

.vitepress/config.mts

@@ -93,138 +93,38 @@ function sidebarDevStar(): DefaultTheme.SidebarItem[] {
         { text: 'app.ini配置文件', link: 'src/devstar/install/app-ini' },
       ]
     } as any,
-    {
-      text: '管理',
-      collapsible: true, // 使整个组可折叠
-      collapsed: true, // 默认展开
-      items: [
-        { text: '命令行', link: 'https://docs.gitea.com/zh-cn/administration/command-line' },
-        { text: '认证', link: 'https://docs.gitea.com/zh-cn/administration/authentication' },
-        { text: '环境变量清单', link: 'https://docs.gitea.com/zh-cn/administration/environment-variables' },
-        { text: '备份与恢复', link: 'https://docs.gitea.com/zh-cn/administration/backup-and-restore' },
-        { text: 'Email设置', link: 'https://docs.gitea.com/zh-cn/administration/email-setup' },
-        { text: 'Git LFS设置', link: 'https://docs.gitea.com/zh-cn/administration/git-lfs-setup' },
-        { text: 'HTTPS配置', link: 'https://docs.gitea.com/zh-cn/administration/https-setup' },
-        { text: '设置Fail2ban', link: 'https://docs.gitea.com/zh-cn/administration/fail2ban-setup' },
-        { text: '反向代理', link: 'https://docs.gitea.com/zh-cn/administration/reverse-proxies' },
-        { text: '嵌入资源提取工具', link: 'https://docs.gitea.com/zh-cn/administration/cmd-embedded' },
-        { text: '配置说明', link: 'https://docs.gitea.com/zh-cn/administration/config-cheat-sheet' },
-        { text: '日志配置', link: 'https://docs.gitea.com/zh-cn/administration/logging-config' },
-        { text: '邮件模板', link: 'https://docs.gitea.com/zh-cn/administration/mail-templates' },
-        { text: '仓库索引器', link: 'https://docs.gitea.com/zh-cn/administration/repo-indexer' },
-        { text: 'GPG提交签名', link: 'https://docs.gitea.com/zh-cn/administration/signing' },
-        { text: '外部渲染器', link: 'https://docs.gitea.com/zh-cn/administration/external-renderers' },
-        { text: '搜索引擎索引', link: 'https://docs.gitea.com/zh-cn/administration/search-engines-indexation' },
-        { text: '自定义Gitea配置', link: 'https://docs.gitea.com/zh-cn/administration/customizing-gitea' },
-        { text: '添加法律页面', link: 'https://docs.gitea.com/zh-cn/administration/adding-legal-pages' }
-      ]
-    } as any,
     {
       text: '使用',
       collapsible: true, // 使整个组可折叠
-      collapsed: true, // 默认展开
+      collapsed: false, // 默认展开
       items: [
-        { text: 'devcontainer', link: 'src/devstar/usage/quick-start-with-ai' },
+        { text: '快速入门AI+', link: 'src/devstar/usage/quick-start-with-ai' },
         {
-          text: 'Actions',
+          text: 'CI/CD工作流Actions',
           collapsible: true, // 使整个组可折叠
           collapsed: false, // 默认展开
           items: [
-            { text: 'Overview', link: 'https://docs.gitea.com/zh-cn/usage/actions/overview' },
-            { text: '快速入门', link: 'https://docs.gitea.com/zh-cn/usage/actions/quickstart' },
-            { text: '与GitHub Actions的对比', link: 'https://docs.gitea.com/zh-cn/usage/actions/comparison' },
-            { text: 'Act Runner', link: 'https://docs.gitea.com/zh-cn/usage/actions/act-runner' },
-            { text: '变量', link: 'https://docs.gitea.com/zh-cn/usage/actions/actions-variables' },
-            { text: 'Gitea Actions设计', link: 'https://docs.gitea.com/zh-cn/usage/actions/design' },
-            { text: '密钥管理', link: 'https://docs.gitea.com/zh-cn/usage/actions/secrets' },
-            { text: 'Gitea Actions常见问题解答', link: 'https://docs.gitea.com/zh-cn/usage/actions/faq' },
-            { text: 'Badge', link: 'https://docs.gitea.com/zh-cn/usage/actions/badge' }
+            { text: 'Overview', link: 'src/devstar/actions/overview' },
+            { text: '快速入门', link: 'src/devstar/actions/quickstart' },
           ]
         },
         {
-          text: '软件包',
+          text: '开发容器DevContainer',
           collapsible: true, // 使整个组可折叠
-          collapsed: true, // 默认展开
+          collapsed: false, // 默认展开
           items: [
-            { text: '软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/overview' },
-            { text: 'Alpine 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/alpine' },
-            { text: 'Arch package registry', link: 'https://docs.gitea.com/zh-cn/usage/packages/arch' },
-            { text: 'Cargo 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/cargo' },
-            { text: 'Chef 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/chef' },
-            { text: '存储', link: 'https://docs.gitea.com/zh-cn/usage/packages/storage' },
-            { text: 'Composer 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/composer' },
-            { text: 'Conan 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/conan' },
-            { text: 'Conda 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/conda' },
-            { text: '容器注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/container' },
-            { text: 'CRAN 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/cran' },
-            { text: 'Go 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/go' },
-            { text: 'Helm Chart 注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/helm' },
-            { text: 'Maven 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/maven' },
-            { text: 'NPM Package Registry', link: 'https://docs.gitea.com/zh-cn/usage/packages/npm' },
-            { text: 'NuGet 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/nuget' },
-            { text: 'Pub 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/pub' },
-            { text: 'PyPI 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/pypi' },
-            { text: 'RPM 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/packages/rpm' },
-            { text: 'RubyGems 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/rubygems' },
-            { text: 'Swift 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/swift' },
-            { text: 'Vagrant 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/vagrant' },
-            { text: '通用软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/generic' },
-            { text: 'Debian 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/debian' }
+            { text: 'Overview', link: 'src/devstar/devcontainer/overview' },
+            { text: '快速入门', link: 'src/devstar/devcontainer/quickstart' },
           ]
         },
-        { text: 'AGit', link: 'https://docs.gitea.com/zh-cn/usage/agit' },
-        { text: '个人资料 README', link: 'https://docs.gitea.com/zh-cn/usage/profile-readme' },
-        { text: 'Blame File View', link: 'https://docs.gitea.com/zh-cn/usage/blame' },
-        { text: '邮件接收', link: 'https://docs.gitea.com/zh-cn/usage/incoming-email' },
-        { text: '标签', link: 'https://docs.gitea.com/zh-cn/usage/labels' },
-        { text: '合并请求', link: 'https://docs.gitea.com/zh-cn/usage/pull-request' },
-        { text: '权限', link: 'https://docs.gitea.com/zh-cn/usage/permissions' },
-        { text: '模板仓库', link: 'https://docs.gitea.com/zh-cn/usage/template-repositories' },
-        { text: '从模板创建工单与合并请求', link: 'https://docs.gitea.com/zh-cn/usage/issue-pull-request-templates' },
-        { text: '自动链接引用', link: 'https://docs.gitea.com/zh-cn/usage/automatically-linked-references' },
-        { text: '合并消息模板', link: 'https://docs.gitea.com/zh-cn/usage/merge-message-template' },
-        { text: '推送', link: 'https://docs.gitea.com/zh-cn/usage/push' },
-        { text: 'Blocking a user', link: 'https://docs.gitea.com/zh-cn/usage/blocking-user' },
-        { text: '克隆过滤器 (部分克隆)', link: 'https://docs.gitea.com/zh-cn/usage/clone-filters' },
-        { text: 'Code Owners', link: 'https://docs.gitea.com/zh-cn/usage/code-owners' },
-        { text: 'Webhooks', link: 'https://docs.gitea.com/zh-cn/usage/webhooks' },
-        { text: 'Migration', link: 'https://docs.gitea.com/zh-cn/usage/migration' },
-        { text: '受保护的标签', link: 'https://docs.gitea.com/zh-cn/usage/protected-tags' },
-        { text: '仓库镜像', link: 'https://docs.gitea.com/zh-cn/usage/repo-mirror' },
-        { text: 'Markdown', link: 'https://docs.gitea.com/zh-cn/usage/markdown' },
-        { text: 'Multi-factor Authentication (MFA)', link: 'https://docs.gitea.com/zh-cn/usage/multi-factor-authentication' }
       ]
     } as any,
     {
-      text: '开发',
+      text: '更多帮助',
       collapsible: true, // 使整个组可折叠
-      collapsed: true, // 默认展开
+      collapsed: false, // 默认展开
       items: [
-        { text: '玩转 Gitea', link: 'https://docs.gitea.com/zh-cn/development/hacking-on-gitea' },
-        { text: 'API 使用指南', link: 'https://docs.gitea.com/zh-cn/development/api-usage' },
-        { text: 'OAuth2 提供者', link: 'https://docs.gitea.com/zh-cn/development/oauth2-provider' },
-        { text: '迁移接口', link: 'https://docs.gitea.com/zh-cn/development/migrations-interfaces' },
-        { text: '集成', link: 'https://docs.gitea.com/zh-cn/development/integrations' }
-      ]
-    } as any,
-    {
-      text: '贡献',
-      collapsible: true, // 使整个组可折叠
-      collapsed: true, // 默认展开
-      items: [
-        { text: '后端开发指南', link: 'https://docs.gitea.com/zh-cn/contributing/guidelines-backend' },
-        { text: '前端开发指南', link: 'https://docs.gitea.com/zh-cn/contributing/guidelines-frontend' },
-        { text: '重构指南', link: 'https://docs.gitea.com/zh-cn/contributing/guidelines-refactoring' },
-        { text: '本地化', link: 'https://docs.gitea.com/zh-cn/contributing/localization' }
-      ]
-    } as any,
-    {
-      text: '帮助',
-      collapsible: true, // 使整个组可折叠
-      collapsed: true, // 默认展开
-      items: [
-        { text: '常见问题', link: 'https://docs.gitea.com/zh-cn/help/faq' },
-        { text: '支持选项', link: 'https://docs.gitea.com/zh-cn/help/support' },
+        { text: 'Gitea常见问题', link: 'https://docs.gitea.com/zh-cn/help/faq' },
       ]
     } as any,
   ]

deploy.yaml

@@ -44,7 +44,7 @@ spec:
         targetPort: http
   template:
     type: stateless
-    image: ${DOCKER_REGISTRY_ADDRESS}/${DOCKER_REPOSITORY_ARTIFACT}:${DOCKER_IMAGE_TAG}
+    image: devstar.cn/devstar/devstar-docs:latest
     ports:
       - name: http
         port: 80

src/devstar/actions/overview.md

@@ -0,0 +1,56 @@
+# DevStar CI/CD工作流 Actions Overview
+
+DevStar基于Gitea Actions开发了开箱即用的CI/CD工作流解决方案, 兼容Github Actions生态系统。
+
+> - 本站中Actions是指DevStar开箱即用的CI/CD工作流解决方案，从不同方面兼容Gitea Actions和Github Actions。
+> - 本站中actions/action是指Actions要使用的脚本/插件，比如"actions/checkout@v4" 或 "kekxv/AiReviewPR@v0.0.6"。
+
+## Actions的安装配置方法
+
+- DevStar安装过程中会默认启动一个全局的Actions Runner；
+- 一键启动Actions Runner
+
+在项目设置、用户设置、组织设置和后台管理中，如果当前用户有创建Actions Runner的权限，可在工作流Actions板块下点击【创建新运行器】，找到【一键启动运行器】可以创建相应作用范围的Actions Runner。
+
+- 手工启动Actions Runner
+
+在项目设置、用户设置、组织设置和后台管理中，可以在工作流Actions板块下点击【创建新运行器】，可以复制Registration Token。
+
+> 不同位置复制的Registration Token创建的Actions Runner有不同的作用范围。
+
+```
+$ docker run  --name devstar-runner -d -v /var/run/docker.sock:/var/run/docker.sock \
+    -e GITEA_INSTANCE_URL=${YOUR_DEVSTAR_URL} \  
+    -e GITEA_RUNNER_REGISTRATION_TOKEN=${YOUR_DEVSTAR_RUNNER_REGISTRATION_TOKEN} \ 
+    devstar.cn/devstar/act_runner:latest
+```
+
+## 使用actions短链接的好处
+
+在DevStar CI/CD工作流配置文件中（如.gitea/workflows/ci-cd.yaml）使用不包含域名的actions短链接，DevStar会智能判断当前平台上是否有相同名称的仓库或镜像仓库，如有则使用当前平台的仓库，没有则默认使用github.com上的仓库。
+
+```
+     - name: 🔍 Check out repository code
+        uses: actions/checkout@v4
+
+     - name: AI Review code
+        uses: kekxv/AiReviewPR@v0.0.6
+
+     - name: Report Test Results 
+        if: always() && github.event_name == 'pull_request'
+        uses: actions/github-script@v6
+```
+
+> 类似以上actions短链接仓库，如果在当前DevStar平台上创建相应的镜像仓库，可以智能选择拉取本平台上的仓库，从而避免github.com网络访问问题影响CI/CD工作流的执行。
+
+## 调试CI/CD工作流
+
+DevStar已支持在线调试CI/CD工作流配置文件脚本，调试方法如下：
+
+- 在项目仓库页面点击【工作流/Actions】，然后选择进入某个工作流，右上角【编辑并运行工作流】即可修改脚本再次执行，运行成功后可以直接提交到对应的仓库分支。
+
+> 本地配置调试CI/CD工作流的方法参见：
+> - https://cli.github.com
+> - [GitHub Local Actions](https://sanjulaganepola.github.io/github-local-actions-docs/)
+> - https://nektosact.com/
+

src/devstar/actions/quickstart.md

@@ -0,0 +1,3 @@
+
+# DevStar CI/CD工作流 Actions 快速入门
+

src/devstar/devcontainer/overview.md

@@ -0,0 +1,4 @@
+# DevStar DevContainer Overview
+
+
+

src/devstar/devcontainer/quickstart.md

@@ -0,0 +1,3 @@
+
+# DevStar DevContainer 快速入门
+