Skip to content

Adapt mechanism for citiation count #3177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

dfuchss
Copy link
Contributor

@dfuchss dfuchss commented May 25, 2025

Summary

This PR introduces an automated mechanism to update the citation count for authors' publications.

Key Changes

  • Adds an action to update publication citation counts.
    • Note: This action creates a commit on the main branch.
    • To trigger further GitHub Actions workflows from this commit, a Personal Access Token (PAT) must be used (the default GitHub Actions token cannot trigger subsequent workflows).
  • Adds and manages citation data in _data/citations.yml.
  • Adds and adapts bin/update_scholar_citations.py to handle citation updates.

Usage Examples

image

Outstanding Tasks

  • Add thorough documentation (suggestions for location are welcome).
  • Discuss whether the action should always require a PAT for commits, as not using one will prevent CI from being triggered.

Copy link

netlify bot commented May 25, 2025

Deploy Preview for relaxed-lollipop-b6bc17 ready!

Name Link
🔨 Latest commit d49d586
🔍 Latest deploy log https://app.netlify.com/projects/relaxed-lollipop-b6bc17/deploys/687e8af4e6996800083b703c
😎 Deploy Preview https://deploy-preview-3177--relaxed-lollipop-b6bc17.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@dfuchss dfuchss marked this pull request as ready for review May 26, 2025 18:59
@george-gca
Copy link
Collaborator

What are the reasons for the Personal Access Token (PAT) to be needed? I don't think I completely understand it.

@dfuchss
Copy link
Contributor Author

dfuchss commented Jul 16, 2025

Without a Personal Access Token (PAT), everything will function normally except that the commit updating citations.yml won't trigger any subsequent GitHub Actions --- meaning the update of the citation count won't be deployed. To ensure the CI pipeline runs after the commit, you need to use a PAT (see https://github.com/orgs/community/discussions/25702)

@george-gca
Copy link
Collaborator

Can you also add a section in CUSTOMIZE.md teaching how one could set up the personal key?

@dfuchss
Copy link
Contributor Author

dfuchss commented Jul 16, 2025

Can you also add a section in CUSTOMIZE.md teaching how one could set up the personal key?

Sure. I'll update the PR.

@dfuchss
Copy link
Contributor Author

dfuchss commented Jul 16, 2025

@george-gca I've added the section.

From my point of view, we have two options:

a) before merging, you should create a PAT secret for al-folio itself, otherwise the action will fail
b) by default we could comment the part in the action regarding the PAT; then users that want to use PAT, need to uncomment that part in the action.

What do you think?

@dfuchss dfuchss requested a review from george-gca July 16, 2025 21:19
@george-gca
Copy link
Collaborator

I prefer the second one, since I don't have permission to create the token myself (only @alshedivat does). I just checked, and our deploy workflow have a manual dispatch option, so could you add it to the CUSTOMIZE.md the information that if you don't want to create a token, you can forcefully run the deploy action manually?

@dfuchss dfuchss requested a review from george-gca July 17, 2025 16:40
@dfuchss
Copy link
Contributor Author

dfuchss commented Jul 17, 2025

@george-gca it's now adapted accordingly

Idea adapted from https://github.com/BernardoCama/BernardoCama.github.io

Add section regarding PAT for Google Scholar Citations
@dfuchss dfuchss force-pushed the feature/scholar-fetch branch from 7c545f0 to 85d4316 Compare July 19, 2025 07:16
@dfuchss
Copy link
Contributor Author

dfuchss commented Aug 2, 2025

@george-gca do you need further changes :) ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

google scholar citation count no longer working.
2 participants