docs: add readme

CODE_OF_CONDUCT.md

@@ -0,0 +1,131 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at the contact information listed at: https://github.com/levibostian/.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][mozilla coc].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][faq]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[mozilla coc]: https://github.com/mozilla/diversity
+[faq]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

README.md

@@ -1,2 +1,108 @@
 # action-hide-sensitive-inputs
-Hide the values of your GitHub Action workflow inputs
+
+Are you sending sensitive data to a GitHub Action workflow as a `workflow_dispatch` input? This Action prevents leaking those values to the logs of your GitHub Action. 
+
+Example: Let's say that one of your Workflow inputs is `email_address` and you want to keep the email address private from the Action logs when running the Workflow. By default, all inputs are visible to the public and therefore, the email address `dana@green.com`, would be visible to the public. However, if you instruct GitHub Actions to keep that email address value private, you will see `***` printed in the Action logs instead of `dana@green.com`. 
+
+> Note: This Action, when it works as intended, can make text in GitHub Action logs hidden from the public. However, this Action is not meant to replace GitHub Action's best practices (such as using [secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets)) to truly keep sensitive data private. This Action was designed to hide inputs, such as an email address, that would be nice to be kept private, but are not critical to be kept private. It's recommended you follow the same practice. 
+
+# Getting started 
+
+Here is an example GitHub Action workflow that uses `workflow_dispatch` and some input data. 
+
+```yaml
+name: Sign up user for Beta
+
+on: 
+  workflow_dispatch:
+    inputs:
+      #######################
+      # This input is sensitive and should be kept private. 
+      # We don't want the value of it shown in the logs when we run this workflow!
+      #######################
+      user_email_address: 
+        description: "Email address to register for the app's beta"
+        required: true 
+
+jobs:
+  register-for-beta:
+    runs-on: ubuntu-latest
+    steps:
+    # Run this GitHub Action before any other steps in your workflow. 
+    - name: Hide the inputs values to keep them private in the logs when running this workflow
+      uses: levibostian/action-hide-sensitive-inputs@1.0.0
+
+    # Safely use ${{ inputs.user_email_address }} in your workflow without worrying that an 
+    # email address getting shown in the logs when running this workflow. 
+    - run: ./register-for-beta --email "${{ inputs.user_email_address }}"
+```
+
+# Options
+
+| Key              | Description                                                                                        | Required? |
+|------------------|----------------------------------------------------------------------------------------------------|-----------|
+| `exclude_inputs` | Comma-separated list of input keys to not hide the value of. Example: `phone-number,email-address` | No        |
+
+# Contributing
+
+Want to contribute to this project and make it better? Thanks for your interest! Here is how to setup your development environment for this project. 
+
+* `npm install`
+* All source code for the Action lives in `index.js` file. 
+* All testing of the plugin is done by GitHub Actions running the Action. Make commits and push those commits to GitHub. After you push, the GitHub Action `.github/workflows/test.yml` will automatically execute and run the Action `.github/workflows/run-action-via-dispatch.yml`. Manually view the logs from executing this workflow to see if the Action behaves correctly. 
+
+# How does this Action work? 
+
+This section of the docs is optional and meant for educational purposes. If you are looking to just use the Action, you can skip this section. 
+
+### How do you hide sensitive inputs in GitHub Action logs?
+
+GitHub Actions provides a feature to hide strings - [`add-mask`](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#masking-a-value-in-log). This feature is handy, but you have to be careful when you use `add-mask` because it's easy to use incorrectly. It's not as easy as: `echo "::add-mask::${{ inputs.user_email_address }}"` because the output of this command will actually show: 
+
+```
+echo "::add-mask::dana@green.com"
+"***"
+```
+
+Yup. The value of the email address will show *before* the `add-mask` takes effect. GitHub Actions prints the command being executed (`echo "::add-mask::dana@green.com"`) and *then* `add-mask` takes effect which is why the next line shows `***` which is the output from running `echo`.  
+
+`add-mask` works, but you need to be thoughtful when using it. While browsing for ideas online on how to hide `workflow_dispatch` input values, I found [this clever use of `add-mask`](https://github.com/actions/runner/issues/643#issuecomment-823537871) which involves JSON parsing. Because `${{ inputs.X }}` is never used, the value is kept secret while `add-mask` gets executed. 
+
+This workflow worked well for me: 
+
+```yaml
+on: 
+  workflow_dispatch:
+    inputs:
+      user_email_address: 
+        description: "Email address to register for the app's beta"
+        required: true 
+
+jobs:
+  register-for-beta:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Create secret environment variables from inputs 
+      run: |
+        EMAIL_ADDRESS=$(jq -r '.inputs.user_email_address' $GITHUB_EVENT_PATH)
+        echo ::add-mask::$EMAIL_ADDRESS
+        echo EMAIL_ADDRESS="$EMAIL_ADDRESS" >> $GITHUB_ENV
+    - name: Now, I can safely use input via environment variable
+      run: echo "$EMAIL_ADDRESS" # the output from this command will be "echo ***"
+```
+
+This solution works, but it is boilerplate heavy and is suspectable to human error. Making the email address value not as safe as it could be. 
+
+This gave me an idea. Create a node script that...
+1. Gets all `workflow_dispatch` input values from the environment variable `$GITHUB_EVENT_PATH`. This way, you don't have to send any data to the node script and potentially leak the value. 
+2. Since the node script controls what information gets printed to the console, this node script could use `add-mask` in the script but be sure not to send any of that code to the output of the node script. 
+3. Allow the ability to exclude inputs from having their values hidden, but by default, make *all* inputs hidden. This avoids forgetting to hide an input. 
+
+The result? One line of code to feel confident that input values will be kept private. 🎉🎉🎉
+
+```yaml
+- uses: levibostian/action-hide-sensitive-inputs@1.0.0
+```
+
+
+

action.yml

@@ -2,7 +2,7 @@ name: 'Hide sensitive inputs'
 description: 'Hide the values of your GitHub Action workflow inputs'
 inputs:
   exclude_inputs: 
-    description: 'Comma-separated list of input names to not hide the value of. Example: phone-number,email-address'
+    description: 'Comma-separated list of input keys to not hide the value of. Example: phone-number,email-address'
     required: false    
 runs:
   using: 'node16'