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.

Sign up for GitHub

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

Feat: Update documentation to describe project setup #20

Closed
wants to merge 1 commit into from
Closed

Feat: Update documentation to describe project setup #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
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 to a New Linux Foundation Project
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of having another section, please move these steps to pre-requisites (see ln 10+) above, there is already a well-maintained doc on how to create SSH keys and use them.

https://docs.releng.linuxfoundation.org/en/latest/gerrit.html#register-key-gerrit

Copy link
Contributor

Choose a reason for hiding this comment

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

Please make this generic so that anyone outside of LF can follow the guide.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Perhaps this should simply be documented on the LF RelEng Confluence Wiki instead? There are concrete steps needed to set this up for LF projects that are NOT for general consumption, which are currently missing. If you want generic documentation, perhaps our internal docs should go elsewhere.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

e.g. https://linuxfoundation.atlassian.net/wiki/spaces/RELEN/pages/190021675/Gerrit+to+platform+for+Github+Actions


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