From 409174a963c8ae6a37526e05be527d56e0e82b0b Mon Sep 17 00:00:00 2001
From: Jairo Llopis <973709+yajo@users.noreply.github.com>
Date: Wed, 26 Jun 2024 07:19:28 +0100
Subject: [PATCH] ci(pre-commit): auto-fix style problems (#1676)

This is another approach to fix the same problem as https://github.com/copier-org/copier/pull/1641 by just letting the CI reformat and push back changes to the origin branch.
---
 .github/workflows/ci.yml | 11 +++++++++++
 CONTRIBUTING.md          | 34 +++++++++++++++++++++++++++++++---
 2 files changed, 42 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index fd1fa43da..c0eba66bc 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -96,6 +96,8 @@ jobs:
           - macos-latest
           - ubuntu-latest
     runs-on: ${{ matrix.os }}
+    permissions:
+      contents: write # Allow pushing back pre-commit changes
     steps:
       - uses: actions/checkout@v4
 
@@ -132,6 +134,15 @@ jobs:
           cache-store: "false"
       - run: copier --version
 
+      # Autoformat and try to push back changes
+      - run: pre-commit run -a
+        continue-on-error: true
+      - uses: stefanzweifel/git-auto-commit-action@v5
+        continue-on-error: true
+        with:
+          commit_message: "style: autoformat with pre-commit"
+          commit_options: --no-verify
+
       # Run nix checks
       - run: nix flake check -L --accept-flake-config --impure
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7c3f12ea3..405674f5d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -63,6 +63,26 @@ your host environment:
     environment.
 -   [Direnv](https://direnv.net/) to load that environment automatically in your shell.
 
+### Without Nix
+
+For some reasons you might want to avoid installing Nix in your system. Maybe you don't
+have enough permissions, you work on Windows, or you just don't want to add yet another
+package manager to your system. We believe Nix is awesome enough so as to be the default
+tool for almost any developer, but we respect your choice.
+
+You can use standard Python tooling such as [Poetry][] and a valid Python installation
+installed in an imperative manner of your choice.
+
+However, you won't be able to auto-lint or auto-format code without Nix. If you don't
+have Nix installed but you have Docker or Podman, you can run `poe lint` and get similar
+results. It will use a container to install Nix, and Nix to install the formatters.
+
+If you still don't have Docker or Podman, don't worry. You can push your changes without
+formatting. As long as you give Copier maintainers permissions to change your PR, a bot
+will kindly auto-format code for you and push it back to your branch.
+
+[Poetry]: https://python-poetry.org/
+
 ## Get Started!
 
 Ready to contribute? Here's how to set up the project for local development.
@@ -83,9 +103,8 @@ Ready to contribute? Here's how to set up the project for local development.
     ```
 
     Direnv will take some time to load for the 1st time. It will download all
-    development dependencies, including [Poetry](https://python-poetry.org/), and it
-    will use it to create a virtualenv and install Copier with all its development
-    dependencies too.
+    development dependencies, including [Poetry][], and it will use it to create a
+    virtualenv and install Copier with all its development dependencies too.
 
 1.  Create a branch for local development:
 
@@ -130,12 +149,21 @@ our [changelog](CHANGELOG.md). Changes that are included there are of type `fix`
 and `refactor`; also `BREAKING CHANGE:` trailers will appear. If your change is not
 meaningful in the changelog, then please don't use one of those categories.
 
+### Maintainer notes
+
 If you're a maintainer and you want to merge a PR that will produce a confusing
 changelog, then please squash the PR on merge, and change the commit message to make it
 meaningful. Remember to
 [respect co-autorship](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors)
 when squashing, especially if multiple authors were involved.
 
+If the last commit is pushed back by `github-actions[bot]` and named
+`style: autoformat with pre-commit`, it's most likely an automatic reformatting commit
+done by the CI.
+[Those kind of commits cannot trigger other workflows](https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#triggering-a-workflow-from-a-workflow).
+Thus, to be able to re-run CI, close and reopen the PR. Consider squashing on merge if
+possible and practical.
+
 ## Tips
 
 To run a subset of tests: