MATH-57: update ci | update citation | add changelog | cleanups

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf
+
+[*.{xml,yml}]
+indent_size = 2

.github/workflows/build-and-deploy-pdf.yml

@@ -4,15 +4,11 @@ on:
   push:
     tags:
       - v*
-    branches:
-      - develop
-      - master
-      - main
-      - release/*
   workflow_dispatch:
 
 env:
   FILE_NAME: "PolynomialIdentityInvolvingBTandFaulhaber"
+  ACTIONS_RUNNER_DEBUG: false
 
 jobs:
   build-pdf:
@@ -21,34 +17,34 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Install GitVersion
-        uses: gittools/actions/gitversion/setup@v0.9.15
+        uses: gittools/actions/gitversion/setup@v1.1.1
         with:
           versionSpec: '5.x'
 
       - name: Determine Version
-        uses: gittools/actions/gitversion/execute@v0.9.15
+        uses: gittools/actions/gitversion/execute@v1.1.1
 
       - name: Print SemVer
         run: |
-          echo ${{ env.GITVERSION_SEMVER }}
-          echo ${{ env.GitVersion_InformationalVersion }}
-          echo ${{ env.GitVersion_EscapedBranchName }}
-          newVersion="${{ env.GITVERSION_SEMVER }}+${{ env.GITVERSION_BRANCHNAME }}.${{ env.GITVERSION_SHORTSHA }}"
+          echo "SemVer: ${{ env.GitVersion_SemVer }}"
+          echo "BranchName: ${{ env.GitVersion_BranchName }}"
+          echo "ShortSha: ${{ env.GitVersion_ShortSha }}"
+          newVersion="${{ env.GitVersion_SemVer }}+${{ env.GitVersion_BranchName }}.${{ env.GitVersion_ShortSha }}"
           echo "Next version: $newVersion"
 
       - name: Update version.tex
         shell: bash
         run: |
-          newVersion="${{ env.GITVERSION_SEMVER }}+${{ env.GITVERSION_BRANCHNAME }}.${{ env.GITVERSION_SHORTSHA }}"
+          newVersion="${{ env.GitVersion_SemVer }}+${{ env.GitVersion_BranchName }}.${{ env.GitVersion_ShortSha }}"
           sed -i "s|Local-0.1.0|$newVersion|" "src/sections/version.tex"
 
       - name: Build PDF
-        uses: xu-cheng/latex-action@v2
+        uses: xu-cheng/latex-action@v3
         with:
           root_file: "${{ env.FILE_NAME }}.tex"
           working_directory: src
@@ -58,7 +54,7 @@ jobs:
           ls -lsa src
 
       - name: Upload artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: "${{ env.FILE_NAME }}-${{ env.GitVersion_InformationalVersion }}"
           path: |
@@ -68,7 +64,7 @@ jobs:
             src/sections
 
       - name: Upload artifacts PDF
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: "${{ env.FILE_NAME }}-PDF-${{ env.GitVersion_InformationalVersion }}"
           path: |
@@ -92,4 +88,4 @@ jobs:
         env:
           USERNAME: "kolosovpetro"
           EMAIL: "kolosovp94@gmail.com"
-          MESSAGE: "CICD deploy of PDF document"
+          MESSAGE: "CICD deploy of ${{ env.FILE_NAME }} PDF document"

.github/workflows/build-pdf.yml

@@ -15,6 +15,7 @@ on:
 
 env:
   FILE_NAME: "PolynomialIdentityInvolvingBTandFaulhaber"
+  ACTIONS_RUNNER_DEBUG: false
 
 jobs:
   build-pdf:
@@ -23,34 +24,34 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Install GitVersion
-        uses: gittools/actions/gitversion/setup@v0.9.15
+        uses: gittools/actions/gitversion/setup@v1.1.1
         with:
           versionSpec: '5.x'
 
       - name: Determine Version
-        uses: gittools/actions/gitversion/execute@v0.9.15
+        uses: gittools/actions/gitversion/execute@v1.1.1
 
       - name: Print SemVer
         run: |
-          echo ${{ env.GITVERSION_SEMVER }}
-          echo ${{ env.GitVersion_InformationalVersion }}
-          echo ${{ env.GitVersion_EscapedBranchName }}
-          newVersion="${{ env.GITVERSION_SEMVER }}+${{ env.GITVERSION_BRANCHNAME }}.${{ env.GITVERSION_SHORTSHA }}"
+          echo "SemVer: ${{ env.GitVersion_SemVer }}"
+          echo "BranchName: ${{ env.GitVersion_BranchName }}"
+          echo "ShortSha: ${{ env.GitVersion_ShortSha }}"
+          newVersion="${{ env.GitVersion_SemVer }}+${{ env.GitVersion_BranchName }}.${{ env.GitVersion_ShortSha }}"
           echo "Next version: $newVersion"
 
       - name: Update version.tex
         shell: bash
         run: |
-          newVersion="${{ env.GITVERSION_SEMVER }}+${{ env.GITVERSION_BRANCHNAME }}.${{ env.GITVERSION_SHORTSHA }}"
+          newVersion="${{ env.GitVersion_SemVer }}+${{ env.GitVersion_BranchName }}.${{ env.GitVersion_ShortSha }}"
           sed -i "s|Local-0.1.0|$newVersion|" "src/sections/version.tex"
 
       - name: Build PDF
-        uses: xu-cheng/latex-action@v2
+        uses: xu-cheng/latex-action@v3
         with:
           root_file: "${{ env.FILE_NAME }}.tex"
           working_directory: src
@@ -60,18 +61,18 @@ jobs:
           ls -lsa src
 
       - name: Upload artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: "${{ env.FILE_NAME }}-${{ env.GitVersion_InformationalVersion }}"
-          path: | 
+          path: |
             src/${{ env.FILE_NAME }}.tex
             src/${{ env.FILE_NAME }}.bbl
             src/${{ env.FILE_NAME }}.bib
             src/sections
 
       - name: Upload artifacts PDF
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: "${{ env.FILE_NAME }}-PDF-${{ env.GitVersion_InformationalVersion }}"
           path: |
-            src/${{ env.FILE_NAME }}.pdf
+            src/${{ env.FILE_NAME }}.pdf

.gitignore

@@ -28,12 +28,12 @@
 ## Generated if empty string is given at "Please type another file name for output:"
 .idea/
 ## Bibliography auxiliary files (bibtex/biblatex/biber):
-*.bbl
-*.bcf
-*.blg
-*-blx.aux
-*-blx.bib
-*.run.xml
+#*.bbl
+#*.bcf
+#*.blg
+#*-blx.aux
+#*-blx.bib
+#*.run.xml
 
 ## Build tool auxiliary files:
 *.fdb_latexmk
@@ -292,4 +292,4 @@ TSWLatexianTemp*
 #*Notes.bib
 
 /publish
-*.zip
+*.zip

BIBTEX-CITATION.bib

@@ -1,7 +1,8 @@
 @misc{kolosov2023polynomial,
-    title = {Polynomial identity involving Binomial Theorem and Faulhaber's formula Source files},
-    author = {Kolosov, Petro},
-    journal = {GitHub},
-    howpublished = "\url{https://github.com/kolosovpetro/PolynomialIdentityInvolvingBTandFaulhaber}",
+    title = {{Polynomial identity involving Binomial Theorem and Faulhaber's formula}},
+    author = {{Kolosov, Petro}},
+    journal = {Figshare},
+    number = {https://doi.org/10.6084/m9.figshare.2386},
+    note = {\url{https://kolosovpetro.github.io/pdf/PolynomialIdentityInvolvingBTandFaulhaber.pdf}},
     year = {2023}
 }

CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2024-09-21
+
+- Update CI/CD actions
+- Update citation
+- Update README.md
+- Add footnote with GitHub repository link
+- Update abstract
+- Update conclusions
+- Update footnote
+- Grammar fix abstract
+- Grammar fix conclusions
+- Grammar fix introduction
+- Grammar fix section 2
+- Grammar fix section 3
+- Grammar fix conclusions

README.md

@@ -2,3 +2,21 @@
 
 ![abs](./img/abstract.PNG)
 
+## Build and run in Intellij IDEA under Windows
+
+- Install `MikTeX`: https://miktex.org/download
+- Update `MikTeX`
+- Install `SumatraPDF` viewer: https://www.sumatrapdfreader.org/download-free-pdf-viewer
+- Path to SumatraPDF: `C:\Program Files\SumatraPDF`
+- Install `Intellij IDEA Ultimate`: https://www.jetbrains.com/idea/download/#section=windows
+- Activate `Intellij IDEA Ultimate`
+- Install `TeXiFy IDEA` plugin: https://plugins.jetbrains.com/plugin/9473-texify-idea
+- Clone this repository locally: `https://github.com/kolosovpetro/github-latex-template.git`
+- Open `github-latex-template` folder in `Intellij IDEA Ultimate` and configure as follows
+    - LaTeX Configuration
+      ![LaTeX Configuration](./img/latex_configuration.PNG "LaTeX Configuration")
+    - BibTeX Configuration
+      ![BibTeX Configuration](./img/bibtex_configuration.PNG "BibTeX Configuration")
+- Configure Inverse Search in `Intellij IDEA` for SumatraPDF: `Tools -> LaTeX -> Configure Inverse Search`
+- Compile document using `Shift + F10`
+

out/PolynomialIdentityInvolvingBTandFaulhaber.bbl

@@ -0,0 +1,86 @@
+\begin{thebibliography}{10}
+
+\bibitem{tkaczyk2018problem}
+{Tkaczyk, Albert}.
+\newblock {About the problem of a triangle developing the polynomial function}.
+\newblock Published electronically at
+  \href{https://www.linkedin.com/pulse/problem-triangle-developing-polynomial-function-fn-nm-albert-tkaczyk/}{\texttt{LinkedIn}},
+  2018.
+
+\bibitem{tkaczyk2018continuation}
+{Tkaczyk, Albert}.
+\newblock {On the problem of a triangle developing the polynomial function -
+  continuation}.
+\newblock Published electronically at
+  \href{https://www.linkedin.com/pulse/problem-triangle-developing-polynomial-function-f-n-m-albert-tkaczyk/}{\texttt{LinkedIn}},
+  2018.
+
+\bibitem{kolosov2022106}
+{Kolosov, Petro}.
+\newblock {106.37 An unusual identity for odd-powers}.
+\newblock {\em {The Mathematical Gazette}}, 106(567):509--513, 2022.
+
+\bibitem{abramowitz1988handbook}
+Milton Abramowitz, Irene~A Stegun, and Robert~H Romer.
+\newblock Handbook of mathematical functions with formulas, graphs, and
+  mathematical tables, 1988.
+
+\bibitem{beardon1996sums}
+Alan~F Beardon.
+\newblock {Sums of powers of integers}.
+\newblock {\em {The American mathematical monthly}}, 103(3):201--213, 1996.
+
+\bibitem{kolosov2017third}
+Petro Kolosov.
+\newblock {Numerical triangle, row sums give third power, Entry A287326 in The
+  On-Line Encyclopedia of Integer Sequences}.
+\newblock Published electronically at \url{https://oeis.org/A287326}, 2017.
+
+\bibitem{kolosov2018fifth}
+Petro Kolosov.
+\newblock {Numerical triangle, row sums give fifth power, Entry A300656 in The
+  On-Line Encyclopedia of Integer Sequences}.
+\newblock Published electronically at \url{https://oeis.org/A300656}, 2018.
+
+\bibitem{kolosov2018seventh}
+Petro Kolosov.
+\newblock {Numerical triangle, row sums give seventh power, Entry A300785 in
+  The On-Line Encyclopedia of Integer Sequences}.
+\newblock Published electronically at \url{https://oeis.org/A300785}, 2018.
+
+\bibitem{alekseyev2018mathoverflow}
+{Alekseyev, Max}.
+\newblock {MathOverflow answer 297916/113033}.
+\newblock Published electronically at
+  \url{https://mathoverflow.net/a/297916/113033}, 2018.
+
+\bibitem{scheuer2023mathstackexchange}
+{Scheuer, Markus}.
+\newblock {MathStackExchange answer 4724343/463487}.
+\newblock Published electronically at
+  \url{https://math.stackexchange.com/a/4724343/463487}, 2023.
+
+\bibitem{bateman1953higher}
+Harry Bateman.
+\newblock {\em {Higher transcendental functions [volumes i-iii]}}, volume~1.
+\newblock McGRAW-HILL book company, 1953.
+
+\bibitem{kolosov2018numerator}
+Petro Kolosov.
+\newblock {Entry A302971 in The On-Line Encyclopedia of Integer Sequences}.
+\newblock Published electronically at \url{https://oeis.org/A302971}, 2018.
+
+\bibitem{kolosov2018denominator}
+Petro Kolosov.
+\newblock {Entry A304042 in The On-Line Encyclopedia of Integer Sequences}.
+\newblock Published electronically at \url{https://oeis.org/A304042}, 2018.
+
+\bibitem{kolosov2023github}
+{Kolosov, Petro}.
+\newblock {Polynomial identity involving Binomial Theorem and Faulhaber's
+  formula Source files}.
+\newblock Published electronically at
+  \url{https://github.com/kolosovpetro/PolynomialIdentityInvolvingBTandFaulhaber},
+  2023.
+
+\end{thebibliography}