Skip to content

Commit

Permalink
Moved, reworded. [skip-tests]
Browse files Browse the repository at this point in the history
  • Loading branch information
alliepiper committed May 17, 2024
1 parent cba1e3e commit 3ad8979
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 22 deletions.
22 changes: 0 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,32 +34,10 @@ Thank you for your interest in contributing to the CUDA C++ Core Libraries (CCCL
4. **Commit Changes**:
Setup ssh signing keys (if needed, see next section) and commit:
```bash
git commit -m "Brief description of the change"
```
### SSH Signing Keys
CCCL projects require commits to be signed with a cryptographic key.
To enable commit signing using your existing ssh key, set the following git options:
```bash
git config --global gpg.format ssh
git config --global user.signingKey "$(cat Location_Of_Your_Public_Key)"
# These settings are optional. They tell git to automatically sign all new commits and tags.
# If these are set to false, use `git commit -S` to manually sign each commit.
git config --global commit.gpgsign true
git config --global tag.gpgsign true
```
Git is now configured to sign commits with your ssh key.
To complete the process, upload the public key to your [Github Signing Keys](https://github.com/settings/keys).
Make sure that the key is uploaded to 'Signing Keys', not just 'Authentication Keys'.
The same key may be used for both.
### Developer Guides
For more information about design and development practices for each CCCL component, refer to the following developer guides:
Expand Down
22 changes: 22 additions & 0 deletions ci-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,28 @@ CCCL uses [NVIDIA's self-hosted action runners](https://docs.gha-runners.nvidia.
The CI pipeline will not start automatically for external contributors. A repository member will first review the changes and initiate the CI pipeline with an `/ok to test` comment.
### SSH Signing Keys
NVIDIA employees on the CCCL team must enable commit signing in order to run CI themselves.
This is not required for external contributions, which will always require an explicit `/ok to test` comment from an approved account for each CI run.
To enable commit signing using your existing ssh key, set the following git options:
```bash
git config --global gpg.format ssh
git config --global user.signingKey "$(cat ~/.ssh/YOUR_PUBLIC_KEY_FILE_HERE.pub)"
# These settings are optional. They tell git to automatically sign all new commits and tags.
# If these are set to false, use `git commit -S` to manually sign each commit.
git config --global commit.gpgsign true
git config --global tag.gpgsign true
```
Git is now configured to sign commits with your ssh key.
To complete the process, upload the public key to your [Github Signing Keys](https://github.com/settings/keys).
Make sure that the key is uploaded to 'Signing Keys', not just 'Authentication Keys'.
The same key may be used for both.
## Troubleshooting CI Failures
1. **Review CI logs**: Examine CI logs for specific error messages (see [Viewing CI Workflow Results](#viewing-ci-workflow-results))
Expand Down

0 comments on commit 3ad8979

Please sign in to comment.