From df8acb14b88a384166bebdc34833fa0129a6752d Mon Sep 17 00:00:00 2001 From: Andrei Jiroh Halili Date: Sun, 14 Sep 2025 22:45:12 +0800 Subject: [PATCH] docs: add contributing docs and update gitignore per previous commit Signed-off-by: Andrei Jiroh Halili --- .gitignore | 2 +- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ README.md | 11 +++++++++++ 3 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/.gitignore b/.gitignore index be821aa..5df4fa2 100644 --- a/.gitignore +++ b/.gitignore @@ -66,7 +66,7 @@ typings/ .yarn-integrity # dotenv environment variables file -.env.keys +!.env.keys .env.vault # parcel-bundler cache (https://parceljs.org/) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a43e899 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing to the project + +## Preflight Checks / Prerequisites + +* Review the [Code of Conduct](./CODE_OF_CONDUCT.md) and the [Linux DCO](https://policies.recaptime.dev/community/open-source/linux-dco). +* Your development environment should have the following installed: + * Node.js (v20 as used in [GitHub Actions](./action.yml) or higher) + +## Setup + +1. Fork the repository and clone it to your local machine. +2. Navigate to the project directory and install dependencies: + +```bash +cd dotenvx-action +npm install +``` + +3. All done! You can now start making changes. + +## Tests + +```bash +npm run test +``` diff --git a/README.md b/README.md index 4f8cc85..0f9469a 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,13 @@ dotenvx set -f .env.ci --plain -- RHQCR_BOT_USERNAME andreijiroh-dev+buildops ### Inputs +> [!NOTE] +> If your dotenvx-encrypted dotenv file is on a different repository, use the [remote loader action](./remote-loader/README.md) instead. + +> [!WARNING] +> If you set `inject-env-vars` to `true`, all decrypted secrets will be injected as environment variables +> for subsequent jobs. If you do not want that, set it to `false` and access secrets via `${{ steps.dotenvx.outputs. }}`. + | Name | Default | Description | | ----------------- | ------------- | -------------------------------------------------------------------------- | | `path` | `.env.ci` | Path to dotenv file to decrypt its encrypted secrets | @@ -61,6 +68,10 @@ the [`dotenv-keys`][dotenv-keys] bash shell hook and function developed by Andre | `DOTENV_DECRYPTION_FAILURE` | Whether there are failed secret decryptions or not | false | | `DOTENV_DECRYPTION_FAIL_COUNT` | Number of secrets failed to decrypt | Defaults to 0 if everything is decrypted, otherwise a number of decryption failures | +## Sub-actions within this action + +* [**Remote loader**](./remote-loader/README.md) - loads dotenvx-encrypted secrets from a remote URL and decrypts them using a provided private key by combining both steps into one composite action. + ## License MIT -- 2.51.2