Skip to content

Commit

Permalink
Feat: Update documentation to describe project setup
Browse files Browse the repository at this point in the history
Signed-off-by: Matthew Watkins <mwatkins@linuxfoundation.org>
  • Loading branch information
ModeSevenIndustrialSolutions committed Oct 18, 2024
1 parent d9a16b0 commit 980be90
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,19 @@ Or, submit each commit as a separate single commit preserving the git history (S
- `ORGANIZATION`: The GitHub Organization or Project.
- `REVIEWER_EMAIL`: Committers' email list (comma-separated list without spaces).

## Deploying for a New Project

1. Create a new GitHub2Gerrit user LFID (this needs to be project specific)
1. Add user to the appropriate organisation/vault in 1Password (e.g. LF Networking/ONAP)
1. Get user added to the appropriate groups (with required Gerrit permissions)
1. Log in to Gerrit web interface/UI (this creates the user account in Gerrit)
1. Create a new SSH key-pair (ed25519) and the SSH key to the user's profile
1. Add the new SSH keys used to the appropriate 1Password vault
1. Add mandatory secrets/vars (documented above) to GitHub

It is recommended to only add secrets/variables to a repository during initial testing.
You can later move them to the ORGANISATION level when ready to go into production.

## Full Example Usage with Composite Action

Use the composite action as a step in the workflow for further processing.
Expand Down

0 comments on commit 980be90

Please # to comment.