Merge pull request #344 from SinCerely023/separated_cls_in_release

Add *.cls into Release and tips about citation keys

.github/workflows/release.yml

@@ -24,9 +24,14 @@ jobs:
         with:
           name: bithesis
           path: bithesis.pdf
+      - name: Upload *.cls for later usage.
+        uses: actions/upload-artifact@v3
+        with:
+          name: cls
+          path: "*.cls"
 
 
-  publish:
+  publish_templates:
     name: Publish ${{ matrix.template }}
     runs-on: ubuntu-latest
     needs: build
@@ -55,3 +60,27 @@ jobs:
           file: ./templates/${{ matrix.template }}.zip
           asset_name: ${{ matrix.template }}.zip
           tag: ${{ github.ref }}
+
+
+  publish_cls:
+    name: Publish ${{ matrix.cls }}
+    runs-on: ubuntu-latest
+    needs: build
+
+    strategy:
+      matrix:
+        cls: [bithesis, bitreport, bitbeamer]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Download *.cls
+        uses: actions/download-artifact@v3
+        with:
+          name: cls
+      - name: Upload ${{ matrix.cls }}.cls to release
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: ${{ matrix.cls }}.cls
+          asset_name: ${{ matrix.cls }}.cls
+          tag: ${{ github.ref }}

bithesis.dtx

@@ -305,6 +305,9 @@
 % 需要注意的是，Github 和 Overleaf 的模板中包含了当前版本的 |*.cls| 文件，
 % 因此不会因为 CTAN 上的更新而导致模板无法编译。（但代价当然是需要手动升级）
 %
+% GitHub 同时提供了独立的 |*.cls| 文件，可以仅下载 |*.cls| 文件并通过上述
+% 第一种方法进行更新。
+%
 % \subsection{版本号与升级}
 %
 % \BIThesisLaTeX 的版本号遵循 \href{https://semver.org/lang/zh-CN/}{语义化版本}，
@@ -1582,7 +1585,7 @@
 %   \end{bitsyntax}
 %
 % \textbf{请注意，如果你的参考文献同时出现在「攻读学位期间发表论文与研究成果清单」和「参考文献」中，
-% 请将条目分别添加进入两个 |.bib| 文件中；切勿重复使用。}
+% 请将条目分别添加进入两个 |.bib| 文件中，并修改它们的key以避免重名；切勿重复使用。}
 %
 % \textit{在「攻读学位期间发表论文与研究成果清单」环境中使用。}
 % 用于添加个人成果，添加过的成果可以通过 |printbibliography| 打印。

templates/graduate-thesis/reference/pub.bib

@@ -34,6 +34,10 @@
 % **\Author 的具体用法请参考手册**。
 
 % `annotation = {}` 一句用于指定条目的补充内容。
+
+% **注意：如果你的参考文献同时出现在「攻读学位期间发表论文与研究成果清单」和「参考文献」中，
+% 请将条目分别添加进入 main.bib 与 pub.bib 文件中，并修改它们的key以避免重名；切勿重复使用。**
+
 @article{myCiteKey,
   title = {交联型与线形水性聚氨酯的形状记忆性能比较},
   author = {张三 and 李杰 and 罗运军},