Add documentation for git-crypt encrypted .authinfo file#2
Conversation
Co-authored-by: eapolinario <653394+eapolinario@users.noreply.github.com>
Co-authored-by: eapolinario <653394+eapolinario@users.noreply.github.com>
|
@copilot if someone forks this repo can they modify the list of encrypted files? |
Co-authored-by: eapolinario <653394+eapolinario@users.noreply.github.com>
Yes, someone who forks the repo can modify |
|
@copilot that format for the authinfo file is not correct, there's no port. Can you find the RFC that describes the format used in |
Co-authored-by: eapolinario <653394+eapolinario@users.noreply.github.com>
Corrected in commit 4fa5eac. The format now follows the Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
|
@copilot , update this |
Could you clarify what you'd like me to update? The documentation currently covers git-crypt setup, the .netrc format for .authinfo, and security considerations for forking. Please let me know what specific information needs to be updated or added. |
|
@copilot resolve the merge conflicts in this pull request |
- Removed README.md (replaced with readme.org in main) - Moved authinfo/README.md to common/authinfo/README.md to match new structure - Updated readme.org to link to detailed authinfo documentation - Updated paths in authinfo README to reflect new repository structure Agent-Logs-Url: https://github.com/eapolinario/dotfiles/sessions/70cfec23-7796-4d30-bfa9-f39407c43de0 Co-authored-by: eapolinario <653394+eapolinario@users.noreply.github.com>
Resolved in commit c72573a. The merge conflicts have been fixed:
|
|
@copilot resolve the merge conflicts in this pull request |
|
@copilot resolve the merge conflicts in this pull request |
…fo-file # Conflicts: # readme.org Co-authored-by: eapolinario <653394+eapolinario@users.noreply.github.com>
…fo-file Co-authored-by: eapolinario <653394+eapolinario@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds/links documentation describing how to work with the git-crypt–encrypted common/authinfo/.authinfo secrets file, aligning with the repo’s readme.org-based top-level documentation.
Changes:
- Add
common/authinfo/README.mddocumenting git-crypt install/unlock usage,.netrc-style.authinfoformat, and fork/security considerations. - Link the new authinfo documentation from the
* Secretssection inreadme.org.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| readme.org | Adds a pointer from the Secrets section to the detailed authinfo/git-crypt documentation. |
| common/authinfo/README.md | Introduces a dedicated authinfo README covering decryption workflow and security guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| If you are the repository owner and want to add a new collaborator who can decrypt these files: | ||
|
|
||
| ```bash | ||
| # Export their GPG public key and add them |
There was a problem hiding this comment.
The “Export their GPG public key” phrasing is misleading here: to run git-crypt add-gpg-user, the collaborator’s public key typically needs to be obtained from them and imported into the maintainer’s GPG keyring first. Consider rewording this comment to reflect “obtain + import their public key”, and (optionally) mention that GPG_KEY_ID can be a fingerprint/email of an imported key.
| # Export their GPG public key and add them | |
| # Obtain and import their GPG public key, then add them | |
| # GPG_KEY_ID can be the fingerprint or email of an imported key |
|
@copilot apply changes based on the comments in this thread |
Update comment to reflect that the collaborator's public key must be obtained and imported before running git-crypt add-gpg-user. Also clarify that GPG_KEY_ID can be a fingerprint or email of an imported key. Agent-Logs-Url: https://github.com/eapolinario/dotfiles/sessions/d16f56b9-23bb-409e-acd7-053c71b983e8 Co-authored-by: eapolinario <653394+eapolinario@users.noreply.github.com>
Applied in commit abfb014. Updated the comment to clarify that the collaborator's public key must be obtained and imported before running git-crypt add-gpg-user, and added a note that GPG_KEY_ID can be a fingerprint or email of an imported key. |
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.