[CS2103T-W16-2] FoodRem

.github/check-line-endings.sh

@@ -3,13 +3,15 @@
 # Prohibited line endings: \r\n
 
 git grep --cached -I -n --no-color -P '\r$' -- ':/' |
+# We want to allow .bat files to have \r\n line endings,
+# since these batch scripts are run on Windows.
 awk '
     BEGIN {
         FS = ":"
         OFS = ":"
         ret = 0
     }
-    {
+    !($1 ~ /\.bat$/) {
         ret = 1
         print "ERROR", $1, $2, " prohibited \\r\\n line ending, use \\n instead."
     }

.github/check-trailing-whitespace.sh

@@ -9,6 +9,10 @@ awk '
         ret = 0
     }
     {
+        # Skip ../gradlew file
+        if ($1 == "../gradlew") {
+            next
+        }
         # Only warn for markdown files (*.md) to accomodate text editors
         # which do not properly handle trailing whitespace.
         # (e.g. GitHub web editor)

.github/workflows/build.yml

@@ -0,0 +1,89 @@
+name: Build
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+    tags:
+      - v*
+
+jobs:
+  jarfile:
+    runs-on: ubuntu-latest
+    outputs:
+      upload_url: ${{ steps.create_release.outputs.upload_url }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+        with:
+          ref: master
+      - name: Validate Gradle Wrapper
+        uses: gradle/actions/wrapper-validation@v5
+      - name: Setup JDK 17
+        uses: actions/setup-java@v5
+        with:
+          distribution: zulu
+          java-version: 17
+          java-package: jdk+fx
+          cache: gradle
+      - name: Create JAR file
+        run: ./gradlew shadowJar
+      - name: Generate tag name from time
+        id: tagname
+        run: echo ::set-output name=TAGNAME::$(echo $(date +%s) | sed -e 's/^../AR/')
+      - name: Generate release name from time
+        id: releasename
+        run: echo "::set-output name=RELEASENAME::$(date '%e %b %Y, %H:%M %Z')"
+        env:
+          TZ: Asia/Singapore
+      - name: Create release on GitHub
+        id: create_release # We need the id to refer to it in the next step
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.tagname.outputs.TAGNAME }}
+          release_name: Auto-release ${{ steps.releasename.outputs.RELEASENAME }}
+          body: 'Auto-created release from branch "${{ github.ref_name }}"'
+      - name: Upload JAR file to GitHub releases
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./build/libs/foodrem.jar
+          asset_name: foodrem.jar
+          asset_content_type: application/java-archive
+  pdfs:
+    needs: jarfile
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up repository
+        uses: actions/checkout@v5
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+      - name: Set up server dependencies
+        working-directory: ${{ github.workspace }}/docs
+        run: gem install --user-install bundler && bundle install
+      - name: Create PDFs of UG and DG
+        working-directory: ${{ github.workspace }}/docs
+        run: ./make-pdf.sh
+      - name: Upload UG to release
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.jarfile.outputs.upload_url }}
+          asset_path: ./docs/release/UserGuide.pdf
+          asset_name: UserGuide.pdf
+          asset_content_type: application/pdf
+      - name: Upload DG to release
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.jarfile.outputs.upload_url }}
+          asset_path: ./docs/release/DeveloperGuide.pdf
+          asset_name: DeveloperGuide.pdf
+          asset_content_type: application/pdf

.github/workflows/check-links.yml

@@ -0,0 +1,21 @@
+name: Check all links on website are valid
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  check-links:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up repository
+        uses: actions/checkout@v5
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+      - name: Set up server dependencies
+        working-directory: ${{ github.workspace }}/docs
+        run: gem install --user-install bundler && bundle install
+      - name: Set up checker dependencies
+        working-directory: ${{ github.workspace }}/cli-test/linkchecker
+        run: npm install
+      - name: Set up server and check all links are valid
+        working-directory: ${{ github.workspace }}/cli-test/linkchecker
+        run: python serve-and-check.py

.github/workflows/check-ppp-edited.yml

@@ -0,0 +1,50 @@
+name: Check PPP is updated
+
+on:
+  - workflow_dispatch
+
+jobs:
+  check-ppp:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up repository
+        uses: actions/checkout@v5
+      - name: Query GraphQL API
+        uses: octokit/[email protected]
+        id: get_latest_prs
+        with:
+          query: |
+            query PRs {
+              repository(owner: "AY2223S1-CS2103T-W16-2", name: "tp") {
+                pullRequests(last: 100) {
+                  totalCount
+                  edges {
+                    node {
+                      title
+                      merged
+                      resourcePath
+                      participants(first: 10) {
+                        edges {
+                          node {
+                            login
+                          }
+                        }
+                      }
+                      headRepositoryOwner {
+                        login
+                      }
+                      number
+                      closed
+                    }
+                  }
+                }
+              }
+            }
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Save query data to file
+        working-directory: ${{ github.workspace }}/cli-test/ppp-checker
+        run: "echo '${{ steps.get_latest_prs.outputs.data }}' > data.json"
+      - name: Validate all PRs are included in PPP
+        working-directory: ${{ github.workspace }}/cli-test/ppp-checker
+        run: ./check-ppp-is-present.sh ${{ github.event.pull_request.user.login }}

.github/workflows/gradle.yml

@@ -11,10 +11,10 @@ jobs:
 
     steps:
       - name: Set up repository
-        uses: actions/checkout@main
+        uses: actions/checkout@v5
 
       - name: Set up repository
-        uses: actions/checkout@main
+        uses: actions/checkout@v5
         with:
           ref: master
 
@@ -23,17 +23,19 @@ jobs:
 
       - name: Run repository-wide tests
         if: runner.os == 'Linux'
-        working-directory:  ${{ github.workspace }}/.github
+        working-directory: ${{ github.workspace }}/.github
         run: ./run-checks.sh
 
       - name: Validate Gradle Wrapper
-        uses: gradle/wrapper-validation-action@v1
+        uses: gradle/actions/wrapper-validation@v5
 
-      - name: Setup JDK 11
-        uses: actions/setup-java@v1
+      - name: Setup JDK 17
+        uses: actions/setup-java@v5
         with:
-          java-version: '11'
+          distribution: zulu
+          java-version: 17
           java-package: jdk+fx
+          cache: gradle
 
       - name: Build and check with Gradle
         run: ./gradlew check coverage
@@ -43,4 +45,4 @@ jobs:
         with:
           directory: ${{ github.workspace }}/build/reports/jacoco/coverage
           files: coverage.xml
-          fail_ci_if_error: true
+          fail_ci_if_error: false

.gitignore

@@ -1,22 +1,24 @@
 # Gradle build files
-/.gradle/
-/build/
+.gradle/
+build/
 src/main/resources/docs/
 
+# VSCode build files
+bin/
+
 # IDEA files
-/.idea/
-/out/
-/*.iml
+.idea/
+out/
+*.iml
 
 # Storage/log files
-/data/
-/config.json
-/preferences.json
-/*.log.*
+data/
+config.json
+preferences.json
+*.log.*
 
 # Test sandbox files
 src/test/data/sandbox/
 
 # MacOS custom attributes files created by Finder
 .DS_Store
-docs/_site/

.markdownlint.jsonc

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://www.schemastore.org/markdownlint.json",
+  "MD004": {
+    "style": "asterisk"
+  },
+  "MD009": {
+    "br_spaces": 0
+  },
+  "MD013": false,
+  "MD029": {
+    "style": "one"
+  },
+  "MD033": {
+    "allowed_elements": ["sub", "sup", "br", "kbd"]
+  },
+  "MD035": {
+    "style": "---"
+  },
+  "MD044": {
+    "names": [
+      "FoodRem",
+      "User Guide",
+      "Developer Guide",
+      "Command Input Box",
+      "Command Output Box",
+      "Item List Box"
+    ],
+    "code_blocks": false
+  },
+  "MD046": {
+    "style": "fenced"
+  },
+  "MD048": {
+    "style": "backtick"
+  },
+  "MD049": {
+    "style": "underscore"
+  },
+  "MD050": {
+    "style": "asterisk"
+  },
+  "MD051": false
+}

.ruby-version

@@ -0,0 +1 @@
+3.4.7