Skip to content

doc: Update script and workflow to update README with arXiv Braket publications#1221

Open
axif0 wants to merge 5 commits intoamazon-braket:mainfrom
axif0:aws
Open

doc: Update script and workflow to update README with arXiv Braket publications#1221
axif0 wants to merge 5 commits intoamazon-braket:mainfrom
axif0:aws

Conversation

@axif0
Copy link

@axif0 axif0 commented Feb 16, 2026

Issue #, if available:
#1192

Description of changes:

  • Add bin/update-braket-publications.py to query the arXiv API for preprints mentioning Amazon Braket from the last 12 months
  • Script uses only the standard library (urllib, xml.etree, datetime, etc.)
  • Outputs a markdown table to README.md with Year, Month, Title, Authors, and Link
  • Includes handling for network errors and empty results
  • Add .github/workflows/update-braket-publications.yml to run the script monthly and open a PR when there are changes
  • Workflow runs only on amazon-braket/amazon-braket-sdk-python and can be triggered manually via workflow_dispatch
image

Testing done:

  • Ran python3 bin/update-braket-publications.py from repo root
  • Confirmed publications were fetched and written to README.md
  • Verified table format and content

Merge Checklist

General

Tests

  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have checked that my tests are not configured for a specific region or account (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@axif0 axif0 requested a review from a team as a code owner February 16, 2026 11:22
@axif0 axif0 changed the title script and workflow to update README with arXiv Braket publications fix: Update script and workflow to update README with arXiv Braket publications Feb 16, 2026
@axif0
Copy link
Author

axif0 commented Feb 19, 2026

The arXiv API only searches text metadata (title, abstract, comments, authors, categories). It does not understand context. If Amazon Braket appears anywhere in those fields, it will be returned. And automatically classified each paper as real usage, ambiguous, or mention-only.

@codecov
Copy link

codecov bot commented Feb 25, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (6664966) to head (7a15c62).

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1221   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          169       169           
  Lines        10835     10835           
  Branches      1382      1382           
=========================================
  Hits         10835     10835           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@speller26 speller26 changed the title fix: Update script and workflow to update README with arXiv Braket publications doc: Update script and workflow to update README with arXiv Braket publications Feb 25, 2026
Comment on lines +94 to +98
if score >= 3:
return "likely_real_usage"
if score > 0:
return "ambiguous_manual_review"
return "mention_only"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably worth an enum to prevent typos when editing this script

Comment on lines +18 to +21
- uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why older version?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bumped actions/checkout and actions/setup-python to v6.

@axif0
Copy link
Author

axif0 commented Feb 26, 2026

@speller26 hello, Is there anything else for improvement?

@axif0 axif0 requested a review from speller26 February 26, 2026 15:36
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.

2 participants