shipnote logoshipnote

Setup

Run the nightly dataset

You need a fork, two settings, and one manual run. The nightly job then runs on your own account.

1. Fork the repository

Fork abhiudayg/shipnote on GitHub.

2. Enable Actions

Forks have GitHub Actions turned off. Open the Actions tab in your fork and enable workflows.

3. Set DATASET_AUTHOR

Add a repository variable named DATASET_AUTHOR under Settings → Secrets and variables → Actions → Variables. Use the git author name or email on your commits. Check them with:

git config user.name
git config user.email

4. Build the first dataset

Open Actions → shipnote nightly dataset → Run workflow, and set days to 30. Scheduled runs use 30 days by default.

Schedule

The workflow runs at 18:30 UTC, which is 00:00 IST. To change the time, edit the cron expression in .github/workflows/nightly-dataset.yml. GitHub can start scheduled runs several minutes late, and public repositories disable scheduled workflows after 60 days without activity.

Run it locally

Requires git and the GitHub CLI, signed in with gh auth login.

LOGIN=your-github-login AUTHOR="Your Name" DAYS=7 scripts/export-commits.sh out

LOGIN and AUTHOR are required. DAYS defaults to 30. Output goes to out/<owner>/<repo>.patch.