Skip to content

Latest commit

 

History

History
62 lines (53 loc) · 3.75 KB

README.md

File metadata and controls

62 lines (53 loc) · 3.75 KB
Raw

rotabot

Introduction

Created by JLaw, riding on the coattails of Mia!

Instructions

  1. Ensure that you have added Johnathan Law to the Slack channel you want to post to.
  2. Get the Rota Spreadsheet set up the way you want it, it has a little bit of complexity!
    • Take a copy of the template sheet, available here.
    • Ensure that the rota spreadsheet is viewable by All Matillion or by Johnathan Law at a minimum.
    • Complete the sheets named Rota and Slack sufficiently. Ensure you have enough days populated in Rota and names in Slack.
    • Slack sheet maps between names in the Rota and how they are mentioned in Slack. Ensure you use the member ID and the format <@MEMBERID>
    • Member ID can be retrieved from a user's profile, clicking on the triple dot menu, and selecting "Copy member ID"
  3. Follow the example configuration block below, and add it to this repository.
    • Commit and push your changes to main inside the config.json file to add a new rota.
  4. This will be triggered the following day at 8am. The file is read from GitHub at execution time.
    • You may wish to use the Slack channel #rotabot-inactive for testing. Its ID is C064EJX84V6.
    • Note that the days-active block is a string - This validates each day (Monday - Friday) if the rota should be posted that day. Y means active, N means inactive.
      • This means YYYYY is every weekday, YNNNN only posts on Monday.

Testing

  1. Take a sample block from the config.json or from the example configuration below.
  2. Ask Johnathan Law for the webhook URL.
  3. Send a POST request to the endpoint, with a slightly modified JSON object as the body.
    • The config array contains the configuration you wish to execute.
    • The today parameter contains the day number we want to act like today is. e.g. 0 = Monday, 1 = Tuesday:
{
  "config": [
    {
      "name": "TESTING",
      "description": "The testing rota",
      "owner": "JLaw",
      "days-active": "YNNNN",
      "spreadsheet": "1LBo8Lt-7Xk8r78Ydobe9fDvtf98JP5yOCzZOjsiTtok",
      "sheet-id": "971719928",
      "slack-channel": "C064EJX84V6",
      "message": "Good morning! :wave: This is a test message!\n`Person A:` <<2>>\n`Person B:` <<3>>\n`Person C:` <<4>>\n`Person D:` <<5>>\n`Person E:` <<6>>\n`Person F:` <<7>>\n`Person G:` <<8>>\n`Person H:` <<9>>\n\nUpdate rota <https://docs.google.com/spreadsheets/d/1LBo8Lt-7Xk8r78Ydobe9fDvtf98JP5yOCzZOjsiTtok/edit?usp=sharing|here>."
    }
  ],
  "today": 0
}

Example Configuration

{
  "name": "TESTING", // The name of this rota
  "description": "The testing rota", // A description of what this rota is for
  "owner": "JLaw", // A person who can be contacted for issues
  "days-active": "YNNNN", // The days that this should message should be sent. Note that the first entry is Monday, and it is index 0.
  "spreadsheet": "1LBo8Lt-7Xk8r78Ydobe9fDvtf98JP5yOCzZOjsiTtok", // The spreadsheet to look at, the value between 'spreadsheets/d/' and '/edit#gid='
  "sheet-id": "971719928", // The ID of the sheet to look at, the value after '/edit#gid=' - note that the first sheet on a spreadsheet is 0.
  "slack-channel": "C064EJX84V6", // The Slack channel to send to, you must provide the channel ID and not the name!
  "message": "Good morning! :wave: This is a test message!\n`Person A:` <<2>>\n`Person B:` <<3>>\n`Person C:` <<4>>\n`Person D:` <<5>>\n`Person E:` <<6>>\n`Person F:` <<7>>\n`Person G:` <<8>>\n`Person H:` <<9>>\n\nUpdate rota <https://docs.google.com/spreadsheets/d/1LBo8Lt-7Xk8r78Ydobe9fDvtf98JP5yOCzZOjsiTtok/edit?usp=sharing|here>. " // The message to send, see https://help.zapier.com/hc/en-us/articles/8496025607181
}