diff --git a/CHANGELOG.md b/CHANGELOG.md index 19c1fab..4835167 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,8 +18,8 @@ View this release on: [Github](https://github.com/enpaul/vault2vault/releases/ta - Fix bug causing stack trace when the same vaulted block appears in a YAML file more than once -- Fix bug where the `--ignore-undecryptable` option was not respected for vaulted variables - in YAML files +- Fix bug where the `--ignore-undecryptable` option was not respected for vaulted + variables in YAML files - Update logging messages and levels to improve verbose output ## Version 0.1.0 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 2382d9d..0530753 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -27,9 +27,10 @@ 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 +- 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 @@ -52,8 +53,8 @@ offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the -community leaders responsible for enforcement at \[INSERT CONTACT METHOD\]. All -complaints will be reviewed and investigated promptly and fairly. +community leaders responsible for enforcement at \[INSERT CONTACT METHOD\]. 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. @@ -105,8 +106,8 @@ toward or disparagement of classes of individuals. 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. -Community Impact Guidelines were inspired by [Mozilla's code of conduct -enforcement ladder](https://github.com/mozilla/diversity). +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at diff --git a/README.md b/README.md index 62a655f..97785ed 100644 --- a/README.md +++ b/README.md @@ -30,10 +30,9 @@ terminal. Whatever, these things happen. The built-in tool Ansible provides, [`ansible-vault rekey`](https://docs.ansible.com/ansible/latest/cli/ansible-vault.html#rekey), suffers from two main drawbacks: first, it only works on vault encrypted files and not on -vault encrypted YAML data; and second, it only works on a single vault encrypted file at -a time. To rekey everything in a large project you'd need to write a script that -recursively goes through every file and rekeys every encrypted file and YAML variable all -at once. +vault encrypted YAML data; and second, it only works on a single vault encrypted file at a +time. To rekey everything in a large project you'd need to write a script that recursively +goes through every file and rekeys every encrypted file and YAML variable all at once. This is that script. @@ -58,8 +57,8 @@ install `vault2vault` using [PipX](https://pypa.github.io/pipx/) and the `ansibl pipx install vault2vault[ansible] ``` -> Note: vault2vault requires an Ansible installation to function. If you are installing to a -> standalone virtual environment (like with PipX) then you must install it with the +> Note: vault2vault requires an Ansible installation to function. If you are installing to +> a standalone virtual environment (like with PipX) then you must install it with the > `ansible` extra to ensure a version of Ansible is available to the application.\*\* ## Usage @@ -117,8 +116,8 @@ data successfully rekeyed and the other half not. In the spirit of the [Unix philosophy](https://hackaday.com/2018/09/10/doing-one-thing-well-the-unix-philosophy/) -this tool does not include any built-in way to recover from this state. However, it can -be done very effectively using a version control tool. +this tool does not include any built-in way to recover from this state. However, it can be +done very effectively using a version control tool. If you are using Git to track your project files then you can use the command `git reset --hard` to restore all files to the state of the currently checked out commit. @@ -160,7 +159,8 @@ roadmap focuses on stability and user experience ahead of a 1.0 release. ## Developer Documentation All project contributors and participants are expected to adhere to the -[Contributor Covenant Code of Conduct, v2](CODE_OF_CONDUCT.md) ([external link](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)). +[Contributor Covenant Code of Conduct, v2](CODE_OF_CONDUCT.md) +([external link](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)). The `devel` branch has the latest (and potentially unstable) changes. The stable releases are tracked on [Github](https://github.com/enpaul/vault2vault/releases),