Next Steps to Complete ORCID Integration
Next Steps to Complete ORCID Integration
β Whatβs Been Completed
All the infrastructure and automation for ORCID integration has been set up:
- Configuration Updated: ORCID URL in
_config.ymlnow points to your profile (0000-0001-6595-5834) - Scripts Created: Three Python scripts for fetching and processing ORCID data
- Workflow Added: GitHub Actions workflow for automatic updates
- Documentation: Comprehensive guides and troubleshooting info
- Security: All CodeQL checks passed, proper permissions configured
π How to Activate (Choose One Method)
Method 1: GitHub Actions (Easiest - Recommended)
- Merge this Pull Request to your main branch
- Go to GitHub.com β Your Repository β Actions tab
- Find the workflow βUpdate ORCID Publicationsβ
- Click βRun workflowβ button
- Select the main branch
- Click green βRun workflowβ button
- Wait 1-2 minutes for completion
- Check the
_publications/directory for new files
Method 2: Run Locally (If You Have Python & Network Access)
# Clone or pull the branch
git clone https://github.com/JohMast/johmast.github.io.git
cd johmast.github.io
# Install dependencies
pip install requests pybtex
# Run the script
cd markdown_generator
python3 orcid_to_publications.py
# Check results
ls -l ../_publications/
# Commit and push if satisfied
cd ..
git add _publications/
git commit -m "Add publications from ORCID"
git push
Method 3: Manual JSON Processing (For Offline Work)
# On a machine with internet:
curl -H "Accept: application/json" \
"https://pub.orcid.org/v3.0/0000-0001-6595-5834/works" \
> orcid_works.json
# Transfer the file, then:
cd markdown_generator
python3 orcid_from_json.py orcid_works.json
# Review and commit
cd ..
git add _publications/
git commit -m "Add publications from ORCID"
git push
π What to Verify After Running
- Check Generated Files:
ls -la _publications/You should see new
.mdfiles with dates and publication titles - Review a Sample File:
cat _publications/[one-of-the-new-files].mdVerify it has proper YAML frontmatter and content
- Test Locally (Optional):
bundle install bundle exec jekyll serveVisit
http://localhost:4000/publications/to see your publications - Check Live Site:
- After pushing to main, GitHub Pages will rebuild (takes 1-5 minutes)
- Visit https://johmast.github.io/publications/
- Verify your publications appear correctly
π Automatic Updates
Once merged, the workflow will automatically:
- Run monthly on the 1st at midnight UTC
- Fetch any new publications from your ORCID
- Create/update publication files
- Commit and push changes
You can also trigger it manually anytime via GitHub Actions.
β οΈ Troubleshooting
No publications generated?
- Check your ORCID profile is public: https://orcid.org/0000-0001-6595-5834
- Ensure works have proper metadata (title, year, etc.)
- Review GitHub Actions logs for errors
Publications missing metadata?
- Some ORCID entries may lack required fields
- Check the script output/logs for warnings
- You can manually edit generated files if needed
Want to customize?
- Edit
markdown_generator/orcid_to_publications.py - Modify publication categorization logic
- Adjust citation formatting
- Change workflow schedule in
.github/workflows/update_orcid_publications.yml
π Documentation
- Main Guide:
markdown_generator/ORCID_UPDATE_README.md - Summary:
ORCID_INTEGRATION_SUMMARY.md - This File:
NEXT_STEPS.md
π― Expected Outcome
After running any of the above methods, you will have:
- Individual markdown files for each ORCID publication in
_publications/ - Publications automatically displayed on your website at
/publications/ - Proper categorization (manuscripts vs conferences)
- Working links to DOIs or URLs
- Properly formatted citations
β Questions or Issues?
If you encounter problems:
- Check the documentation files mentioned above
- Review GitHub Actions logs (if using that method)
- Look for print statements in script output
- Verify ORCID profile has public works with complete metadata
Ready to proceed? Choose Method 1 (GitHub Actions) for the easiest experience!
