CI add auto clean-up workflow (#51)

Author: tomMoral

.github/workflows/clean_template.yml

@@ -0,0 +1,52 @@
+name: Benchmark creation
+
+# This step triggers after a user creates a new repository from the template
+# It replaces the placeholder with the correct names and
+# cleans up template scripts
+
+# This will run every time we create push a commit to `main`
+# Reference https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+permissions:
+  # Need `contents: read` to checkout the repository
+  # Need `contents: write` to update the step metadata
+  contents: write
+
+jobs:
+  clean_template:
+    name: Clean up template
+    runs-on: ubuntu-latest
+    # Only run this action when this repository isn't the template repo
+    if: ${{ !github.event.repository.is_template}}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.12'
+      - name: Clean template scripts
+        run: |
+          python clean_template.py
+
+      # Make a branch, file, commit, and pull request for the learner
+      - name: Commit clean up on the repository
+        run: |
+          echo "Configure git"
+          git config user.name github-actions[bot]
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+          echo "Commit all changes"
+          git commit -am="CLN remove template scripts"
+
+          echo "Push to main"
+          git push
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.rst

@@ -14,7 +14,7 @@ This repo should be used with the following steps:
 
 My Benchopt Benchmark
 =====================
-|Build Status| |Python 3.6+|
+|Build Status| |Python 3.10+|
 
 Benchopt is a package to simplify and make more transparent and
 reproducible comparisons of optimization methods.
@@ -47,7 +47,7 @@ Use ``benchopt run -h`` for more details about these options, or visit https://b
 
 .. |Build Template| image:: https://github.com/benchopt/template_benchmark/actions/workflows/main.yml/badge.svg
    :target: https://github.com/benchopt/template_benchmark/actions
-.. |Build Status| image:: https://github.com/#ORG/#BENCHMARK_NAME/actoiworkflows/main.yml/badge.svg
+.. |Build Status| image:: https://github.com/#ORG/#BENCHMARK_NAME/actions/workflows/main.yml/badge.svg
    :target: https://github.com/#ORG/#BENCHMARK_NAME/actions
-.. |Python 3.6+| image:: https://img.shields.io/badge/python-3.6%2B-blue
-   :target: https://www.python.org/downloads/release/python-360/
+.. |Python 3.10+| image:: https://img.shields.io/badge/python-3.10%2B-blue
+   :target: https://www.python.org/downloads/release/python-3100/

clean_template.py

@@ -32,6 +32,7 @@
     to_remove = [
         Path(".github") / "workflows" / "test_benchmarks.yml",
         Path(".github") / "workflows" / "lint_benchmarks.yml",
+        Path(".github") / "workflows" / "clean_template.yml",
         Path(".") / "clean_template.py"
     ]
     for file in to_remove: