* Add lint in workflow This will check for code formatting, as well as for any ES lint issues. * Format code run `npm run check:write` * Run lint and fix errors Run `npm run lint` and then fix the errors shown.
2.5 KiB
Contributing
Thank you for your interest in contributing to the 1Password load-secrets-action project 👋! Before you start, please take a moment to read through this guide to understand our contribution process.
Testing
Unit tests can be run with npm run test.
After following the steps below for signing commits, you can test against your PR with these steps:
-
Create or use an existing repo to run the
load-secretsGitHub Action. -
In a workflow yaml file that uses the GitHub Action, modify the
uses: 1Password/load-secrets-actionline to beuses: 1Password/load-secrets-action@<branch-name>OR
uses: 1Password/load-secrets-action@<commit-hash> -
Trigger the action, which now includes your changes.
Documentation Updates
If applicable, update the README.md to reflect any changes introduced by the new code.
Sign your commits
To get your PR merged, we require you to sign your commits.
Sign commits with 1Password
You can also sign commits using 1Password, which lets you sign commits with biometrics without the signing key leaving the local 1Password process.
Learn how to use 1Password to sign your commits.
Sign commits with ssh-agent
Follow the steps below to set up commit signing with ssh-agent:
- Generate an SSH key and add it to ssh-agent
- Add the SSH key to your GitHub account
- Configure git to use your SSH key for commits signing
Sign commits with gpg
Follow the steps below to set up commit signing with gpg: