Feat: Add move and replace transformations

Author: politician

dist/index.js

@@ -2,22 +2,26 @@
 
 ## What this action does
 
-This action manages 2 workflows out of the box (push, pr) and essentially does two things:
+This action manages 2 workflows out of the box (**push**, **pr**) and essentially has three steps:
 
 1. **Detect** which workflow to run depending on the context:
 
    - _Push to SoT_ => **push**
-   - _PR opened/changed on destination_ => **pr**
+   - _PR opened/updated on destination_ => **pr**
 
    > If the destination branch doesn't exist on **push**, it will add the flags `--force --init-history`
 
 2. **Generate** a configuration for each workflow
 
+3. **Run** Copybara
+
 ## What you can do
 
 ### Force specific workflows
 
-The following will ensure the **push** workflow is ran using the auto-generated configuration file.
+_The following will let you override step 1 but let Copybara Action perform step 2 and 3._
+
+It will ensure the **push** workflow is ran using the auto-generated configuration file.
 
 ```yaml
 on:
@@ -32,22 +36,25 @@ jobs:
 
       - uses: olivr/[email protected]
         with:
+          ssh_key: ${{ secrets.SSH_KEY }}
           sot_repo: your/repo
           destination_repo: other/repo
           workflow: push
-          ssh_key: ${{ secrets.SSH_KEY }}
 ```
 
 ### Custom Copybara configuration
 
-The following will use your configuration instead of the automatically generated one.
+_The following will let Copybara Action perform step 1 and 3 but let you override step 2._
+
+It will use your configuration instead of the automatically generated one.
 You can get inspiration from the [generated config](#generated-config) to get started.
 
 > This example is still making use of the workflow detection so `my.own.copy.bara.sky` must contain a **push** and a **pr** workflow
 
 ```yaml
 on:
   push:
+  pull_request_target:
 jobs:
   move-code:
     runs-on: ubuntu-latest
@@ -58,15 +65,18 @@ jobs:
 
       - uses: olivr/[email protected]
         with:
+          access_token: ${{ secrets.GH_TOKEN }}
+          ssh_key: ${{ secrets.SSH_KEY }}
           sot_repo: your/repo
           destination_repo: other/repo
           custom_config: my.own.copy.bara.sky
-          ssh_key: ${{ secrets.SSH_KEY }}
 ```
 
 ### Completely custom
 
-The following doesn't make use of any of our helpers for detecting the workflow and generating the configuration.
+_The following will let you override step 1, 2 and let you customize how Copybara Action will perform step 3._
+
+It doesn't make use of any of our helpers for detecting the workflow and generating the configuration.
 It is even using a custom Copybara docker image!
 
 ```yaml
@@ -82,16 +92,18 @@ jobs:
 
       - uses: olivr/[email protected]
         with:
-          workflow: export
+          access_token: ${{ secrets.GH_TOKEN }}
+          ssh_key: ${{ secrets.SSH_KEY }}
+          workflow: create
           custom_config: my.own.copy.bara.sky
           copybara_image: sharelatex/copybara
-          ssh_key: ${{ secrets.SSH_KEY }}
+          copybara_options: --force --init-history
 ```
 
 ### SoT not on GitHub
 
-This action's auto-generated configuration was made for a use case with two GitHub repos. However
-If your SoT is not on GitHub, you can still use this action on your destination using a custom config and forcing a specific workflow:
+This action's auto-generated configuration was made for a use case with two GitHub repos. However, if your SoT is not on GitHub, this action is still helpful.
+Use it on your destination with a custom config and a specific workflow:
 
 ```yaml
 on:
@@ -102,21 +114,20 @@ jobs:
     steps:
       - uses: olivr/[email protected]
         with:
+          ssh_key: ${{ secrets.SSH_KEY }}
           workflow: pr
           custom_config: my.own.copy.bara.sky
-          ssh_key: ${{ secrets.SSH_KEY }}
 ```
 
 ### [More options](inputs.md)
 
 ## Generated config
 
-So you don't have to start your config from scratch, let's download your current generated one.
-
-When you enable debug mode, this action will create an artifact containing your copy.bara.sky configuration.
+So you don't have to start your custom config from scratch, you can download the generated one.
 
 1. In your repo(s), add the secret `ACTIONS_STEP_DEBUG` and set it to `true`
-2. Run the action workflow (most likely create a commit in SoT and a PR in destination)
-3. Check out the artifacts for this workflow run
+2. Run the action workflow (ie. push a commit to SoT and create a PR in destination)
+3. Check out the artifacts for your action workflow runs
 
+It will look like this:
 ![artifact](images/artifact.png)