-
-
Notifications
You must be signed in to change notification settings - Fork 468
docs: Improved verbosity in GPG secrets configuration #3464
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
brosssh
wants to merge
3
commits into
ReVanced:dev
Choose a base branch
from
brosssh:patch-1
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -81,10 +81,11 @@ To start using this template, follow these steps: | |
| and the [About](patches/build.gradle.kts#L5-L11)) | ||
| 3. Update dependencies in the [libs.versions.toml](gradle/libs.versions.toml) file | ||
| 4. [Create a pass-phrased GPG master key and subkey](https://mikeross.xyz/create-gpg-key-pair-with-subkeys/) | ||
| 1. Add the private key as a secret named [GPG_PRIVATE_KEY](.github/workflows/release.yml#L52) to your repository | ||
| 2. Add the passphrase as a secret named [GPG_PASSPHRASE](.github/workflows/release.yml#L53) to your repository | ||
| 3. Add the fingerprint of the GPG subkey as a variable named [GPG_FINGERPRINT](.github/workflows/release.yml#L54) to your repository | ||
| 5. Set up the [README.md](README.md) file[^1] (e.g, title, description, license, summary of the patches | ||
| 5. Add the following GitHub secrets | ||
| 1. [GPG_PRIVATE_KEY](.github/workflows/release.yml#L52): this is the [armored version of your GPG key](https://github.com/crazy-max/ghaction-import-gpg?tab=readme-ov-file#prerequisites) (`gpg --armor --export-secret-key [email protected]`) | ||
| 2. [GPG_PASSPHRASE](.github/workflows/release.yml#L53): this is the passphrase you choosed while creating your GPG key | ||
| 3. [GPG_FINGERPRINT](.github/workflows/release.yml#L54) (optional): this is the fingerprint of the GPG subkey (`gpg --list-secret-keys --keyid-format LONG --with-subkey-fingerprint [email protected]`) | ||
| 6. Set up the [README.md](README.md) file[^1] (e.g, title, description, license, summary of the patches | ||
| that are included in the repository), the [issue templates](.github/ISSUE_TEMPLATE)[^2] and the [contribution guidelines](CONTRIBUTING.md)[^3] | ||
|
|
||
| 🎉 You are now ready to start creating patches! | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Personally I like more adding the commands directly, rather than linking a resource that don't even contain all the required info (or it does but not explicitly).
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A reference avoids a copy of already existing mutable information in its full fledged and always up to date and contextual form.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The linked document is only helpful for setting up GPG_PRIVATE_KEY, it doesn't contain anything related to GPG_FINGERPRINT (unless I'm not seeing something). The fingerprint is actually not a secret there, which could introduce confusion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, GPG_FINGERPRINT should be a variable (since there is no need to hide it), not a secret. This should be clarified
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, the fingerprint should be a variable. The template and our repo should be adjusted for that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this repo the workflow already expects a variable, it's just not explained anywhere in the correct doc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please adjust the suggested change in the PR then. Because right now it lists the fingerprint under "Add the following GitHub secrets"