Skip to content

Latest commit

 

History

History
66 lines (38 loc) · 1.96 KB

README.md

File metadata and controls

66 lines (38 loc) · 1.96 KB
Raw

Open Collective CLI Tools

Prerequisite

  1. Add a Personal Token (API Key) and production API URL in a .env file.
# For GitHub Sponsors AND 1kproject scripts
PERSONAL_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
API_URL=https://api.opencollective.com

# For Slack scripts
# Secrets available on: https://api.slack.com/apps/A04249P7C0N/oauth
SLACK_SIGNING_SECRET=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
SLACK_BOT_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
SLACK_USER_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxx
  1. Run npm install

GitHub Sponsors

CSV Import

  1. Download the CSV file

  2. Launch the dry run with:

node github-sponsors/csv-import.js {CSV_FILE}

If you see:

  • "Detected a new Collective ...", it's recommended to quickly review it and add it to the csv-import-mapping.json file.
  • "Error finding a matching Collective for GitHub Organization ...", you need to investigate and add an entry in the csv-import-mapping.json file.
  1. Happy with the dry run?

node github-sponsors/csv-import.js {CSV_FILE} --run

1kproject

To run the scripts, you need to be an admin of https://opencollective.com/ukrainian-families-1k and https://opencollective.com/foundation. Ask someone to invite you beforehand if necessary.

All scripts support the --yubikey option to use a yubikey instead of TOTP for 2FA.

  1. Download the CSV file and name it with a shorter name like Bulk_07_21.csv

  2. Launch the dry run for Expense Creation with:

node 1kproject/create-expenses.js Bulk_07_21.csv

Check any warning before proceeding, if there is a problem remove the entries from the CSV.

  1. Once happy with the dry run, launch Expense Creation with:

node 1kproject/create-expenses.js Bulk_07_21.csv --run

  1. Trigger the dry run for Expense Payment with:

node 1kproject/pay-expenses.js

Check that the number of approved Expenses is the expected one and that there is no warning.

  1. Proceed Expense Payments with, enter your 2FA token when asked.

node 1kproject/pay-expenses.js --run