Update workflow to create PR instead of pushing to develop directly #57

Signed-off-by: Chin Yeung Li <[email protected]>

Author: chinyeungli

.github/workflows/update-citation.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-          python-version: [3.13]
+        python-version: [3.13]
 
     steps:
       - name: Checkout code
@@ -20,27 +20,38 @@ jobs:
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
-            python-version: ${{ matrix.python-version }}
+          python-version: ${{ matrix.python-version }}
 
       - name: Install doi2cff
         run:
-            pip install
-            git+https://github.com/citation-file-format/doi2cff
+          pip install
+          git+https://github.com/citation-file-format/doi2cff
 
       - name: Fetch latest Zenodo DOI
+        id: get-doi # Assign an ID to this step to reference its outputs
         env:
-            ZENODO_TOKEN: ${{ secrets.ZENODO_TOKEN }}
+          ZENODO_TOKEN: ${{ secrets.ZENODO_TOKEN }}
         run: |
-            python etc/scripts/fetch_latest_doi.py > latest_doi.txt
-            echo "Latest DOI: $(cat latest_doi.txt)"
+          ZENODO_DOI=$(python etc/scripts/fetch_latest_doi.py)
+          echo "ZENODO_DOI=${ZENODO_DOI}" >> "$GITHUB_OUTPUT"
 
       - name: Update CITATION.cff
-        run: doi2cff update $(cat latest_doi.txt)
+        # Use the output from the 'get-doi' step as the argument for doi2cff
+        run: doi2cff update ${{ steps.get-doi.outputs.ZENODO_DOI }}
 
-      - name: Commit updated CITATION.cff
-        run: |
-            git config user.name "github-actions"
-            git config user.email "[email protected]"
-            git add CITATION.cff
-            git commit -m "Update CITATION.cff with latest Zenodo DOI"
-            git push origin HEAD:develop
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          base: develop
+          branch: update-citation-${{ github.event.release.tag_name }}
+          commit-message:
+            'Automated: Update CITATION.cff with the latest Zenodo DOI'
+          title: 'Automated: Update CITATION.cff'
+          body: |
+            This is an automated pull request to update the `CITATION.cff` file
+            with the latest Zenodo DOI fetched from Zenodo repository.
+          # Set to true to automatically merge the PR if all checks pass (optional)
+          # automerge: true
+          # Set to true to delete the branch after merging (optional)
+          # delete-branch: true