Move automations into their own directory; update README (#201)

WordPress · Mar 30, 2022 · 5130502 · 5130502
1 parent a44c229
commit 5130502
Show file tree

Hide file tree

Showing 37 changed files with 45 additions and 26 deletions.
diff --git a/.github/workflows/label_pr.yml b/.github/workflows/label_pr.yml
@@ -23,14 +23,14 @@ jobs:
           python-version: "3.10"
 
       - name: Install dependencies
-        working-directory: ./python
+        working-directory: ./automations/python
         run: |
           python -m pip install --user --upgrade pip
           python -m pip install --user pipenv
           pipenv install --deploy
 
       - name: Label PR
-        working-directory: ./python
+        working-directory: ./automations/python
         run: |
           pipenv run python label_pr.py \
             --pr-url $PR_URL
diff --git a/.github/workflows/label_sync.yml b/.github/workflows/label_sync.yml
@@ -24,13 +24,13 @@ jobs:
           python-version: "3.10"
 
       - name: Install dependencies
-        working-directory: ./python
+        working-directory: ./automations/python
         run: |
           python -m pip install --user --upgrade pip
           python -m pip install --user pipenv
           pipenv install --deploy
 
       - name: Sync standard labels
-        working-directory: ./python
+        working-directory: ./automations/python
         run: |
           pipenv run python sync_labels.py
diff --git a/.github/workflows/pr_project_automation.yml b/.github/workflows/pr_project_automation.yml
@@ -23,21 +23,21 @@ jobs:
           python-version: "3.10"
 
       - name: Install dependencies
-        working-directory: ./python
+        working-directory: ./automations/python
         run: |
           python -m pip install --user --upgrade pip
           python -m pip install --user pipenv
           pipenv install --deploy
 
       - name: Clear PRs in "Merged!"
-        working-directory: ./python
+        working-directory: ./automations/python
         run: |
           pipenv run python archive_column.py \
           --project-number 8 \
           --column 'Merged!'
 
       - name: Clear PRs in "Closed"
-        working-directory: ./python
+        working-directory: ./automations/python
         run: |
           pipenv run python archive_column.py \
           --project-number 8 \

diff --git a/.github/workflows/project_automation.yml b/.github/workflows/project_automation.yml
@@ -24,22 +24,22 @@ jobs:
           python-version: "3.10"
 
       - name: Install dependencies
-        working-directory: ./python
+        working-directory: ./automations/python
         run: |
           python -m pip install --user --upgrade pip
           python -m pip install --user pipenv
           pipenv install --deploy
 
       - name: Move issues from "To do"
-        working-directory: ./python
+        working-directory: ./automations/python
         run: |
           pipenv run python issues_with_prs.py \
           --project-number 3 \
           --source-column "To do" \
           --target-column "In progress"
 
       - name: Move issues from "Backlog"
-        working-directory: ./python
+        working-directory: ./automations/python
         run: |
           pipenv run python issues_with_prs.py \
           --project-number 3 \

diff --git a/.github/workflows/weekly_updates.yml b/.github/workflows/weekly_updates.yml
@@ -25,9 +25,9 @@ jobs:
           node-version: 14
 
       - name: Install dependencies
-        working-directory: ./js
+        working-directory: ./automations/js
         run: npm ci
 
       - name: Create draft post
-        working-directory: ./js
+        working-directory: ./automations/js
         run: node src/last_week_tonight.js
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -44,9 +44,11 @@ repos:
     rev: 3.9.2
     hooks:
       - id: flake8
+        args:
+          - --config=automations/.flake8
 
   - repo: https://github.com/ambv/black
-    rev: 21.6b0
+    rev: 22.3.0
     hooks:
       - id: black
         args:

diff --git a/README.md b/README.md
@@ -54,12 +54,12 @@ to the project with our
 
 ## Repository structure
 
-- **`python/`:** This directory contains scripts written in Python.
-  - Use this as the working directory when executing Python scripts.
-  - Requires [Pipenv](https://pipenv.pypa.io) as the package manager.
-
-- **`js/`:** This directory contains scripts written in JavaScript.
-  - Use this as the working directory when executing JavaScript scripts.
-  - Requires [npm](https://www.npmjs.com) as the package manager.
-
+- **`automations/`:** This directory contains scripts related to project management or one-off tasks.
+  - **`python/`:** This directory contains scripts written in Python.
+    - Use this as the working directory when executing Python scripts.
+    - Requires [Pipenv](https://pipenv.pypa.io) as the package manager.
+  - **`js/`:** This directory contains scripts written in JavaScript.
+    - Use this as the working directory when executing JavaScript scripts.
+    - Requires [npm](https://www.npmjs.com) as the package manager.
 - **`brand/`:** This directory contains brand assets for the project.
+- **`rfcs/`:** This directory contains proposals for changes to Openverse.
diff --git a/.flake8 → automations/.flake8 b/.flake8 → automations/.flake8
diff --git a/automations/README.md b/automations/README.md
@@ -0,0 +1,14 @@
+# Automations
+
+This directory contains automations for managing the Openverse repositories and Developer Experience.
+
+## Requirements
+
+- Node v14
+  - This should be kept in sync between the GitHub Actions `node-version` and the `volta.node` key in the `package.json` file.
+- Python 3.10
+- [Just](https://github.com/casey/just) command runner
+
+## Installing Dependencies
+
+Run `just install` to set up Python and JavaScript dependencies.
diff --git a/data/github.yml → automations/data/github.yml b/data/github.yml → automations/data/github.yml
diff --git a/data/labels.yml → automations/data/labels.yml b/data/labels.yml → automations/data/labels.yml
diff --git a/js/.eslintrc.js → automations/js/.eslintrc.js b/js/.eslintrc.js → automations/js/.eslintrc.js
diff --git a/js/.gitignore → automations/js/.gitignore b/js/.gitignore → automations/js/.gitignore
diff --git a/js/package-lock.json → automations/js/package-lock.json b/js/package-lock.json → automations/js/package-lock.json
diff --git a/js/package.json → automations/js/package.json b/js/package.json → automations/js/package.json
@@ -3,5 +3,8 @@
     "@octokit/rest": "^18.9.0",
     "js-yaml": "^4.1.0",
     "node-fetch": "^2.6.7"
+  },
+  "volta": {
+    "node": "14.19.1"
   }
 }
diff --git a/js/prettier.config.js → automations/js/prettier.config.js b/js/prettier.config.js → automations/js/prettier.config.js
diff --git a/js/src/last_week_tonight.js → automations/js/src/last_week_tonight.js b/js/src/last_week_tonight.js → automations/js/src/last_week_tonight.js
diff --git a/js/src/migrate_issues.js → automations/js/src/migrate_issues.js b/js/src/migrate_issues.js → automations/js/src/migrate_issues.js
diff --git a/js/src/utils.js → automations/js/src/utils.js b/js/src/utils.js → automations/js/src/utils.js
diff --git a/js/src/weekly_report.js → automations/js/src/weekly_report.js b/js/src/weekly_report.js → automations/js/src/weekly_report.js
diff --git a/python/.gitignore → automations/python/.gitignore b/python/.gitignore → automations/python/.gitignore
diff --git a/python/Pipfile → automations/python/Pipfile b/python/Pipfile → automations/python/Pipfile
diff --git a/python/Pipfile.lock → automations/python/Pipfile.lock b/python/Pipfile.lock → automations/python/Pipfile.lock
diff --git a/python/README.md → automations/python/README.md b/python/README.md → automations/python/README.md
diff --git a/python/archive_column.py → automations/python/archive_column.py b/python/archive_column.py → automations/python/archive_column.py
diff --git a/python/issues_with_prs.py → automations/python/issues_with_prs.py b/python/issues_with_prs.py → automations/python/issues_with_prs.py
diff --git a/python/label_pr.py → automations/python/label_pr.py b/python/label_pr.py → automations/python/label_pr.py
diff --git a/python/models/__init__.py → automations/python/models/__init__.py b/python/models/__init__.py → automations/python/models/__init__.py
diff --git a/python/models/label.py → automations/python/models/label.py b/python/models/label.py → automations/python/models/label.py
diff --git a/python/models/label_group.py → automations/python/models/label_group.py b/python/models/label_group.py → automations/python/models/label_group.py
diff --git a/python/shared/__init__.py → automations/python/shared/__init__.py b/python/shared/__init__.py → automations/python/shared/__init__.py
diff --git a/python/shared/data.py → automations/python/shared/data.py b/python/shared/data.py → automations/python/shared/data.py
diff --git a/python/shared/github.py → automations/python/shared/github.py b/python/shared/github.py → automations/python/shared/github.py
diff --git a/python/shared/log.py → automations/python/shared/log.py b/python/shared/log.py → automations/python/shared/log.py
diff --git a/python/shared/project.py → automations/python/shared/project.py b/python/shared/project.py → automations/python/shared/project.py
diff --git a/python/sync_labels.py → automations/python/sync_labels.py b/python/sync_labels.py → automations/python/sync_labels.py
diff --git a/justfile b/justfile
@@ -8,31 +8,31 @@ default:
 # Dev #
 #######
 
-# Install Python dependencies in Pipenv environments
+# Install Python dependencies in Pipenv environments and JS dependencies
 @install:
     just _py-install
     just _js-install
 
 # Setup pre-commit as a Git hook
 precommit:
-    cd python && pipenv run pre-commit install
+    cd automations/python && pipenv run pre-commit install
 
 # Run pre-commit to lint and reformat all files
 lint:
-    cd python && pipenv run pre-commit run --all-files
+    cd automations/python && pipenv run pre-commit run --all-files
 
 ##########
 # Python #
 ##########
 
 # Install dependencies for Python
 _py-install:
-    cd python && pipenv install --dev
+    cd automations/python && pipenv install --dev
 
 ##############
 # JavaScript #
 ##############
 
 # Install dependencies for JavaScript
 _js-install:
-    cd js && npm install
+    cd automations/js && npm install