Skip to content
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

Update README to include signing key config #347

Merged
merged 2 commits into from
Apr 4, 2024

Conversation

Griffin-Sullivan
Copy link
Contributor

No description provided.

README.md Outdated
@@ -114,6 +114,12 @@ For running jobs in Jenkins, make sure you have [access](https://theforeman.gith
gopass edit theforeman/jenkins-token --create
```

For pushing tags in theforeman repositories, you will need to sign your commits. To do so, add your gpg key id as your signing key for git by running:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd move this under the general Setup section, not Gopass. It's also not pushing tags to the repos, but rather creating signed tags. Pushing is the step beyond that. Perhaps something like:

Suggested change
For pushing tags in theforeman repositories, you will need to sign your commits. To do so, add your gpg key id as your signing key for git by running:
Foreman requires GPG signed git tags. Configure git with your personal gpg key id as your signing key:

README.md Outdated
Foreman requires GPG signed git tags. Configure git with your personal gpg key id as your signing key:

```
git config --global user.signingKey <your-key-id>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can align it with the same for gopass init below. I'd assume most people use the same GPG key for both.

Suggested change
git config --global user.signingKey <your-key-id>
git config --global user.signingKey <YOUR-PUB-KEY-HASH>

@ekohl ekohl merged commit e673b69 into theforeman:master Apr 4, 2024
3 checks passed
@ekohl ekohl mentioned this pull request Aug 6, 2024
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants