Quarterly recipe maintenance tasks #4
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Quarterly recipe maintenance tasks | |
| on: | |
| schedule: | |
| - cron: "8 0 1 */3 *" | |
| workflow_dispatch: | |
| jobs: | |
| job: | |
| runs-on: ubuntu-22.04 | |
| permissions: | |
| issues: write | |
| steps: | |
| - name: Create periodic recipe maintenance issue | |
| shell: python | |
| run: | | |
| import datetime | |
| import math | |
| import os | |
| import re | |
| import sys | |
| import requests | |
| quarter = math.ceil(datetime.date.today().month/3.) | |
| payload = { | |
| "title": f"Q{quarter} {datetime.datetime.now().strftime('%Y')} Recipes Maintenance", | |
| "body": os.getenv("ISSUE_BODY"), | |
| "labels": re.sub(r"\s", "", os.getenv("LABELS", "")).split(",") or None, | |
| "assignees": re.sub(r"\s", "", os.getenv("ASSIGNEES", "")).split(",") or None, | |
| } | |
| api_url = f"https://api.github.com/repos/{os.getenv('REPO')}/issues" | |
| url = f"https://github.com/{os.getenv('REPO')}/issues" | |
| headers = { | |
| "Accept": "application/vnd.github.v3+json", | |
| "Authorization": f"token {os.getenv('ACCESS_TOKEN')}", | |
| } | |
| resp = requests.get(api_url, headers=headers) | |
| if resp.status_code != 200: | |
| print(f"❌ Couldn't retrieve issues for {url} using {api_url}.") | |
| print(f"HTTP {resp.status_code} {resp.reason} - {resp.text}") | |
| print("Check your `ACCESS_TOKEN` secret.") | |
| sys.exit(1) | |
| resp = requests.post(api_url, headers=headers, json=payload) | |
| if resp.status_code != 201: | |
| print(f"❌ Couldn't create issue for {url}") | |
| print(f"HTTP {resp.status_code} {resp.reason} - {resp.text}") | |
| sys.exit(1) | |
| print(f"✅ Issue successfully created at {url}/{resp.json().get('number')}") | |
| sys.exit(0) | |
| env: | |
| ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| REPO: openzim/zim-requests | |
| LABELS: recovery | |
| ASSIGNEES: benoit74 | |
| ISSUE_BODY: | | |
| In order to maintain Zimfarm recipes up-to-date, some manual actions are needed. | |
| This ticket requests the assignees to perform following tasks. | |
| ### TED | |
| See https://github.com/openzim/zimfarm/blob/main/dispatcher/backend/maint-scripts/create_ted_topics_recipes.py | |
| Typical usage: | |
| ``` | |
| # setup proper optim cache URL | |
| export TED_OPTIM_CACHE_URL="https://s3.us-west-1.wasabisys.com/..." | |
| # setup credentials to your user with at least editor rights | |
| export ZF_USER="..." | |
| export ZF_PWD="..." | |
| python maint-scripts/create_ted_topics_recipes.py $ZF_USER $ZF_PWD | |
| ``` | |
| - [ ] Update (add / delete) the list of TED recipes per topic, including necessary ZIM deletion requests | |
| - [ ] Update the list of topics in https://farm.openzim.org/recipes/ted_topic_all (until https://github.com/openzim/ted/issues/213 is solved) | |
| - [ ] Once new recipes have completed (they will automatically be started by periodic scheduler after at most one hour), check their ZIM and then move them to prod | |
| **Note**: this is an *automatic reminder* intended for the assignee(s). | |