GitHub Action to sync your earned Credly badges into a GitHub profile README using Credly's public JSON endpoint.

Japanese documentation is available in README.ja.md.

• Fetches badge data from the public Credly endpoint
• Updates only the README section wrapped by markers
• Commits and pushes changes only when the content actually changed
• Supports sort, max_badges, badge_width, and dry_run
• Fails without modifying the README when fetching fails or markers are missing

To display badges on your GitHub profile, first create your profile repository named <your-github-username>/<your-github-username>. The README.md in that repository is shown on your profile page, so add the marker section below:

## Certifications
<!--START_SECTION:badges-->
<!--END_SECTION:badges-->

Then add a workflow to the same profile repository:

name: Update Credly Badges
on:
  schedule:
    - cron: "0 2 * * *"
  workflow_dispatch:

permissions:
  contents: write

jobs:
  update:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: kpab/credly-readme@v1
        with:
          credly_user: <your-credly-username>
          sort: LATEST
          badge_width: 100

actions/checkout and permissions: contents: write are required.

1. Create a GitHub profile repository named <your-github-username>/<your-github-username>.
2. Add <!--START_SECTION:badges--> and <!--END_SECTION:badges--> to its README.md.
3. Add .github/workflows/update-credly-badges.yml and call this action with uses: kpab/credly-readme@v1.
4. Set with.credly_user to your Credly username.
5. Run the workflow once with workflow_dispatch or wait for the scheduled run, then confirm the README is updated.

Minimal repository layout:

<your-github-username>/
├── README.md
└── .github/
    └── workflows/
        └── update-credly-badges.yml

src/
  credly.ts
  render.ts
  readme.ts
  git.ts
  index.ts
tests/
  render.test.ts
  readme.test.ts

CI is expected to run lint, tests, ncc build, and a generated dist diff check.

• The endpoint https://www.credly.com/users/{user}/badges.json is an unofficial public JSON endpoint and depends on the user's public profile settings.
• If Credly changes or removes that endpoint, this action will be affected.
• The fetch logic includes a 10-second timeout and basic retries for transient network failures.