Base commit

Cleanup from template

Branding changes

.gitignore

@@ -65,3 +65,4 @@ typings/
 
 # next.js build output
 .next
+/.github/workflows/test.yml

CODEOWNERS

@@ -1 +1 @@
-* @actions/actions-runtime
+* @pvcy/gh-action-team

README.md

@@ -1,116 +1,62 @@
-# Create a JavaScript Action
+# Anonymize Data with Privacy Dynamics
 
-<p align="center">
-  <a href="https://github.com/actions/javascript-action/actions"><img alt="javscript-action status" src="https://github.com/actions/javascript-action/workflows/units-test/badge.svg"></a>
-</p>
+This GitHub Action allows you to anonymize sensitive data using Privacy Dynamics, an online service that uses state-of-the-art
+algorithms to ensure privacy and anonymity of production data. This action will help you protect sensitive production data
+in dev, test, and preview environments without disclosing customer data.
 
-Use this template to bootstrap the creation of a JavaScript action.:rocket:
+# Prerequisites
 
-This template includes tests, linting, a validation workflow, publishing, and versioning guidance.
+This action requires the following:
 
-If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
+* An active Privacy Dynamics account. Don't have one? You can get one [here](https://signup.privacydynamics.io/).
+* Source data stored in a Postgresql, accessible to the Privacy Dynamics service.
+* A configured Project within your Privacy Dynamics account using your Postgresql data source as a Origin Connection.
+* Machine-to-machine credentials for your account. [Contact us](mailto:[email protected]) so we can generate those for you.
 
-## Create an action from this template
+# Usage
 
-Click the `Use this Template` and provide the new repo details for your action
-
-## Code in Main
-
-Install the dependencies
-
-```bash
-npm install
-```
-
-Run the tests :heavy_check_mark:
-
-```bash
-$ npm test
-
- PASS  ./index.test.js
-  ✓ throws invalid number (3ms)
-  ✓ wait 500 ms (504ms)
-  ✓ test runs (95ms)
-...
-```
-
-## Change action.yml
-
-The action.yml defines the inputs and output for your action.
-
-Update the action.yml with your name, description, inputs and outputs for your action.
-
-See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
-
-## Change the Code
-
-Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
-
-```javascript
-const core = require('@actions/core');
-...
-
-async function run() {
-  try {
-      ...
-  }
-  catch (error) {
-    core.setFailed(error.message);
-  }
-}
-
-run()
-```
-
-See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
-
-## Package for distribution
-
-GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.
-
-Actions are run from GitHub repos.  Packaging the action will create a packaged action in the dist folder.
-
-Run prepare
-
-```bash
-npm run prepare
-```
-
-Since the packaged index.js is run from the dist folder.
-
-```bash
-git add dist
-```
-
-## Create a release branch
-
-Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions.
-
-Checkin to the v1 release branch
-
-```bash
-git checkout -b v1
-git commit -a -m "v1 release"
-```
-
-```bash
-git push origin v1
-```
-
-Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.
-
-Your action is now published! :rocket:
-
-See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-
-## Usage
-
-You can now consume the action by referencing the v1 branch
+To use this action in your GitHub repository, you need to create a workflow file (e.g. `.github/workflows/anonymize.yml`) with the
+following contents:
 
 ```yaml
-uses: actions/javascript-action@v1
-with:
-  milliseconds: 1000
-```
-
-See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket:
+name: Anonymize Data
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  anonymize:
+  runs-on: ubuntu-latest
+  steps:
+  - name: Anonymize Data
+    uses: pvcy/anonymize-project@v1
+  with:
+    project-id: 4e1213f4-my-project-uuid-0242ac120002
+    db-host: my_postgres_host.host.com
+    db-port: 5432
+    db-username: postgres_username
+    db-password: postgres_password
+    client-id: ClientIDFromYourPDAccount
+    client-secret: ClientSecretFromYourPDAccount
+```
+
+# Configuration Parameters
+The following configuration parameters can be used to customize the behavior of the action:
+
+* `project-id` (required): The ID of Privacy Dynamics Project configured to anonymize data for this instance of the GitHub Action.
+* `db-host` (required, default: `localhost`): Hostname of Postgresql engine to send anonymized data to. Must be made accessible to GitHub Actions runner.
+* `db-port` (required, default: `5432`): Port of Postgresql engine to send anonymized data to.
+* `db-username` (required): Username of Postgresql engine to send anonymized data to.
+* `db-password` (required): Password of Postgresql engine to send anonymized data to.
+* `client-id` (required): M2M Client ID provided from your Privacy Dynamics account.
+* `client-secret` (required): Client secret provided from your Privacy Dynamics account.
+* `api-url` (optional): API Url for Privacy Dynamics. Defaults to SaaS instance. This is only required if you are running the On-Prem version of Privacy Dynamics.
+
+
+# Contributing
+
+If you want to contribute to this project, feel free to submit pull requests or open issues on GitHub.
+
+# License
+
+This project is licensed under the MIT License. See the LICENSE file for details.

action.yml

@@ -1,13 +1,38 @@
-name: 'Wait'
-description: 'Wait a designated number of milliseconds'
+name: 'Privacy Dynamics Github Action'
+description: 'Trigger a Job Run in a pre-configured Project in your Privacy Dynamics account'
 inputs:
-  milliseconds:  # id of input
-    description: 'number of milliseconds to wait'
+  project-id:
+    description: 'ID of PD Project configured to anonymize data for this instance of the Github Action'
     required: true
-    default: '1000'
-outputs:
-  time: # output will be available to future steps
-    description: 'The current time after waiting'
+  db-host:
+    description: 'Hostname of Postgresql engine to send anonymized data to. Must be made accessible to GH Actions runner.'
+    required: false
+    default: 'localhost'
+  db-port:
+    description: 'Port of Postgresql engine to send anonymized data to.'
+    required: false
+    default: '5432'
+  db-username:
+    description: 'Username of Postgresql engine to send anonymized data to.'
+    required: true
+  db-password:
+    description: 'Password of Postgresql engine to send anonymized data to.'
+    required: true
+  client-id:
+    description: 'M2M Client ID provided from your Privacy Dynamics account'
+    required: true
+  client-secret:
+    description: 'Client secret provided from your Privacy Dynamics account'
+    required: true
+  api-url:
+    description: 'API Url for Privacy Dynamics. Defaults to SaaS instance.'
+    required: false
+  oauth-domain:
+    description: 'Domain in which to retrieve an access token. For testing purposes only'
+    required: false
 runs:
   using: 'node16'
   main: 'dist/index.js'
+branding:
+  color: 'black'
+  icon: 'shield'