Add Rollout Feature

README.md

@@ -2,9 +2,30 @@
 
 Run this action on a schedule to automatically remove inactive Copilot licenses. It also creates a report as a job summary and csv.
 
+In addition to this it can also deploy users from a CSV file.  This is useful as you are adopting Copilot as it can help facilitate the process of adding users to your organization.
+
 ## Usage
 Create a workflow (eg: `.github/workflows/copilot-license-cleanup.yml`). See [Creating a Workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).
 
+### Deploying users from a CSV file
+
+If you want to deploy users from a CSV file you will need to create a CSV file with the following columns:
+- `organization` - The organization to add the user to
+- `deployment_group` - An arbitrary group name used to track the deployments
+- `login` - The user's GitHub Login name to add
+- `activation_date` - The date the user should be activated (YYYY-MM-DD)
+
+Example:
+
+```csv
+organization,deployment_group,login,activation_date
+exampleorg1,group1,octocat,2024-01-15
+exampleorg1,group1,octodog,2024-01-15
+```
+
+This requires the users to already exist as members of the enterprise and target organization.
+
+If you are using Enterprise Managed Users, it may be easier to use a group from your identity provider to manage the users.  You can assign the group to a team in an organization and assign that team to Copilot.  This will allow you to manage the users in your identity provider and have them automatically added/removed from Copilot as group membership changes.
 
 ### PAT(Personal Access Token)
 
@@ -29,14 +50,14 @@ jobs:
     name: Copilot Seats
     runs-on: ubuntu-latest
     steps:
-      - uses: austenstone/copilot-license-cleanup@v1.1
+      - uses: austenstone/copilot-license-cleanup@v1.2
         with:
           github-token: ${{ secrets.TOKEN }}
 ```
 
 #### Example Auto remove
 ```yml
-      - uses: austenstone/copilot-license-cleanup@v1.1
+      - uses: austenstone/copilot-license-cleanup@v1.2
         with:
           github-token: ${{ secrets.TOKEN }}
           remove: true
@@ -45,7 +66,7 @@ jobs:
 
 #### Example Custom days before inactive
 ```yml
-      - uses: austenstone/copilot-license-cleanup@v1.1
+      - uses: austenstone/copilot-license-cleanup@v1.2
         with:
           github-token: ${{ secrets.TOKEN }}
           remove: true
@@ -55,23 +76,23 @@ jobs:
 
 #### Example Specifying multiple organizations: 
 ```yml
-      - uses: austenstone/copilot-license-cleanup@v1.1
+      - uses: austenstone/copilot-license-cleanup@v1.2
         with:
           github-token: ${{ secrets.TOKEN }}
           organization: exampleorg1, demoorg2, myorg3
 ```
 
 #### Example specifying a GitHub Enterprise (to run on all organizations in the enterprise):
 ```yml
-      - uses: austenstone/copilot-license-cleanup@v1.1
+      - uses: austenstone/copilot-license-cleanup@v1.2
         with:
           github-token: ${{ secrets.TOKEN }}
           enterprise: octodemo
 ```
 
-#### Example uploading inactive users JSON artifact
+#### Example uploading inactive users JSON artifact (same could be done with deployed-seats)
 ```yml
-      - uses: austenstone/copilot-license-cleanup@v1.1
+      - uses: austenstone/copilot-license-cleanup@v1.2
         id: copilot
         with:
           github-token: ${{ secrets.TOKEN }}
@@ -85,6 +106,38 @@ jobs:
           path: inactive-seats.json
 ```
 
+#### Example deploying users from a CSV file 
+
+```yml
+name: Copilot License Review
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * *'
+jobs:
+  copilot:
+    name: Copilot Seats
+    runs-on: ubuntu-latest
+      # Checkout your repo so we can access the CSV file
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - uses: austenstone/[email protected]
+        id: copilot_job
+        with:
+          organization: octodemo, avocadocorp
+          github-token: ${{ secrets.TOKEN }}
+          remove: false
+          remove-from-team: false
+          inactive-days: 30
+          deploy-users: true
+          csv: true
+          # Optional inputs
+          deploy-users-dry-run: false    # Default is true
+          deploy-users-csv: ./copilot-users.csv
+          deploy-validation-time: 3
+```
+
 <details>
   <summary>Job summary example</summary>
 
@@ -106,6 +159,10 @@ Various inputs are defined in [`action.yml`](action.yml):
 | inactive&#x2011;days | The number of days to consider a user inactive | 90 |
 | job-summary | Whether to output a summary of the job | true |
 | csv | Whether to output a CSV of inactive users | false |
+| deploy-users | Whether to deploy users from a CSV file | false |
+| deploy-users-dry-run | Whether to perform a dry run when deploying users | true |
+| deploy-users-csv | CSV file location if deploying users | ./copilot-users.csv |
+| deploy-validation-time | The number of days to attempt to deploy the user beyond activation date | 3 |
 
 ## ⬅️ Outputs
 | Name | Description |
@@ -114,6 +171,8 @@ Various inputs are defined in [`action.yml`](action.yml):
 | inactive-seat-count | The number of inactive seats |
 | removed-seats | The number of seats removed |
 | seat-count | The total number of seats |
+| deployed-seats | JSON array of deployed seats |
+| deployed-seat-count | The number of deployed seats |
 
 ## How does it work?
 We're simply leveraging the [GitHub Copilot API](https://docs.github.com/en/rest/copilot). First we fetch all the Copilot seats and filter them to only inactive seats. Then if the seat is assigned directly we remove it but if it's assigned through a team we remove the user from the team. Those inactive users are reported as a CSV and a job summary table.

action.yml

@@ -38,6 +38,22 @@ inputs:
     description: Whether to output a CSV of the inactive users
     default: false
     required: false
+  deploy-users:
+    description: Whether to deploy users from a CSV file
+    default: false
+    required: false
+  deploy-users-dry-run:
+    description: Whether to do a dry run of deploying users but not actually deploy
+    default: true
+    required: false
+  deploy-users-csv:
+    description: CSV file location if deploying users
+    default: ./copilot-users.csv
+    required: false
+  deploy-validation-time:
+    description: The number of days to attempt to deploy the user beyond activation date
+    default: 3
+    required: false
 
 outputs:
   inactive-seats:
@@ -48,6 +64,10 @@ outputs:
     description: The number of seats removed
   seat-count:
     description: The total number of seats
+  deployed-seats:
+    description: JSON array of deployed seats
+  deployed-seat-count:
+    description: The number of deployed seats
 
 runs:
   using: "node16"