Merge pull request #84 from fkie-cad/add-api-key-usage

Use API key when fetching citation information

.github/workflows/experimental.yml

@@ -44,6 +44,7 @@ jobs:
   # Build job
   build:
     runs-on: ubuntu-latest
+    environment: github-pages
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -68,7 +69,9 @@ jobs:
         run: pip install pandas matplotlib seaborn requests
 
       - name: Fetch citation information from papers
-        run: python tools/count_citations.py
+        env: 
+          S2_API_KEY: ${{ secrets.S2_API_KEY }}
+        run: python tools/count_citations.py --api-key $S2_API_KEY
 
       - name: Generate CSV assets # must happen after fetching citation info
         run: python tools/generate_csv.py

.github/workflows/jekyll.yml

@@ -31,6 +31,7 @@ jobs:
   # Build job
   build:
     runs-on: ubuntu-latest
+    environment: github-pages
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -55,7 +56,9 @@ jobs:
         run: pip install pandas matplotlib seaborn requests
 
       - name: Fetch citation information from papers
-        run: python tools/count_citations.py
+        env: 
+          S2_API_KEY: ${{ secrets.S2_API_KEY }}
+        run: python tools/count_citations.py --api-key $S2_API_KEY
 
       - name: Generate CSV assets # must happen after fetching citation info
         run: python tools/generate_csv.py

.github/workflows/keep_alive.yml

@@ -0,0 +1,16 @@
+name: API Key Keep Alive
+
+on:
+  schedule:
+    - cron: "0 1 * * SUN" # At 01:00 on Sunday
+
+jobs:
+  keep_alive:
+    runs-on: ubuntu-latest
+    environment: github-pages
+    steps:
+      - name: Make a single API request to prevent the API key from expiring
+        env: 
+          S2_API_KEY: ${{ secrets.S2_API_KEY }}
+        run: |
+          wget -qO- --header="x-api-key: $S2_API_KEY" --header="Content-Type: application/json" "https://api.semanticscholar.org/graph/v1/paper/431f7fb6c9e12aaaa8dcc2abefa1c6514ab40074"