vote-bot

A github action/bot to run conda-forge-style votes.

Usage

In your repo create a GitHub Action like this

name: vote-bot

on:
  schedule:
    - cron: '23 15 * * *'
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}

jobs:
  vote-bot:
    name: vote-bot
    runs-on: "ubuntu-latest"
    steps:
      - uses: actions/checkout@v3
      - uses: beckermr/vote-bot@main
        with:
          matrix_username: ${{ secrets.MATRIX_USERNAME }}
          matrix_password: ${{ secrets.MATRIX_PASSWORD }}
          matrix_room_id: ${{ secrets.MATRIX_ROOM_ID }}
          matrix_home_server: "https://matrix-client.matrix.org"
          email: <email to send vote notices>
          email_password: ${{ secrets.EMAIL_PASSWORD }}
          # change these to match the email address sending your vote notices
          email_smtp_server: smtp.gmail.com
          email_smtp_port: 587
          vote_notice_email: <destination email for vote notices>
          vote_directory: votes
          vote_defaults: |
            org: conda-forge
            duration: 10

Each vote is a YAML file with the contents:

org: conda-forge  # name of org holding the vote
start_time:  # unix timestamp of when vote starts
            # make via python -c "import time; print(time.time())"
duration: 10  # duration of vote in days
title: "Vote to add foo to conda-forge"  # title of vote
description: |  # description of vote
  This is a vote to add foo to conda-forge.  Please vote yes or no.

Configuring Matrix

The matrix room is specified by its ID. To get the ID of the room:

1. navigate to the room settings menu
2. go to the "Advanced" pane
3. copy the "internal ID"

Configuring Email

Email authentication is done using a username and password. If you use two-factor with Gmail, you may need to generate an app password.