lukasz1mroz / leetcode-sync

GitHub Action for syncing LeetCode submissions to GitHub

LeetCode Sync

GitHub Action for automatically syncing LeetCode submissions to a GitHub repository.

Features

• Syncs accepted solutions from LeetCode to the default branch of the GitHub repo
• Only syncs solutions that have not been synced before
• Uploads the latest accepted solution for a single problem if there are multiple submissions per day

How to use

1. Login to LeetCode and obtain the csrftoken and LEETCODE_SESSION cookie values.

   • After logging in, right-click on the page and press Inspect.
   • Refresh the page.
   • Look for a network request to https://leetcode.com.
   • Look under Request Headers for the cookie: attribute to find the values.

2. Create a new GitHub repository to host the LeetCode submissions.

   • It can be either private or public.

3. Add the values from step 1 as GitHub secrets, e.g. LEETCODE_CSRF_TOKEN and LEETCODE_SESSION.

4. Go to REPO > settings > actions and in Workflow Permissions section give actions Read and Write permissions.

5. Add a workflow file with this action under the .github/workflows directory, e.g. sync_leetcode.yml.

   Example workflow file:

   name: Sync Leetcode
   
   on:
     workflow_dispatch:
     schedule:
       - cron: "0 8 * * 6"
   
   jobs:
     build:
       runs-on: ubuntu-latest
   
       steps:
         - name: Sync
           uses: joshcai/[email protected]
           with:
             github-token: ${{ github.token }}
             leetcode-csrf-token: ${{ secrets.LEETCODE_CSRF_TOKEN }}
             leetcode-session: ${{ secrets.LEETCODE_SESSION }}
             destination-folder: my-folder
             verbose: true
             commit-header: '[LeetCode Sync]'

6. After you've submitted a LeetCode solution, run the workflow by going to the Actions tab, clicking the action name, e.g. Sync Leetcode, and then clicking Run workflow. The workflow will also automatically run once a week by default (can be configured via the cron parameter).

Inputs

• github-token (required): The GitHub access token for pushing solutions to the repository
• leetcode-csrf-token (required): The LeetCode CSRF token for retrieving submissions from LeetCode
• leetcode-session (required): The LeetCode session value for retrieving submissions from LeetCode
• filter-duplicate-secs: Number of seconds after an accepted solution to ignore other accepted solutions for the same problem, default: 86400 (1 day)
• destination-folder (optional): The folder in your repo to save the submissions to (necessary for shared repos), default: none
• verbose (optional): Adds submission percentiles and question numbers to the repo (requires an additional API call), default: true
• commit-header (optional): How the automated commits should be prefixed, default: 'Sync LeetCode submission'

Shared Repos

Problems can be routed to a specific folder within a single repo using the destination-folder input field. This is useful for users who want to share a repo to add a more social, collaborative, or competitive aspect to their LeetCode sync repo.

Contributing

Testing locally

If you want to test changes to the action locally without having to commit and run the workflow on GitHub, you can edit src/test_config.js to have the required config values and then run:

$ node index.js test

If you're using Replit, you can also just use the Run button, which is already configured to the above command.

Adding a new workflow parameter

If you add a workflow parameter, please make sure to also add it in src/test_config.js, so that it can be tested locally.

You will need to manually run:

$ git add -f src/test_config.js

Since this file is in the .gitignore file to avoid users accidentally committing their key information.

FAQ

Job fails with "HttpError: API rate limit exceeded for installation ID <id>"

This likely means that you hit a rate limit when committing to GitHub (this may happen if you have over ~300 submissions initially). Since the syncer writes in reverse chronological order, it should pick up syncing submissions from where it left off on the next run of the workflow, so just retry the workflow manually after some time.

Job fails with "HttpError: Resource not accessible by integration"

This means the github token you're using does not have permission to write to your repo. If you're using the default github.token method follow the instructions [here] (https://docs.github.com/en/actions/security-guides/automatic-token-authentication)

Acknowledgements

Special thanks to the following people who helped beta test this GitHub Action and gave feedback on improving it:

• dengl11
• uakfdotb
• hexecute
• JonathanZhu11