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

Fix: Update owner to lfit #2

Merged
merged 1 commit into from
Jul 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .github/workflows/call-g2g-composite-action.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ jobs:
- uses: actions/checkout@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
- name: "Call the askb/github2gerrit composite action"
- name: "Call the lfit/github2gerrit composite action"
id: gerrit-upload
uses: askb/github2gerrit@main
uses: lfit/github2gerrit@main
with:
FETCH_DEPTH: 10
GERRIT_KNOWN_HOSTS: ${{ vars.GERRIT_KNOWN_HOSTS }}
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/call-g2g-reusable-workflow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
# Copyright 2024 The Linux Foundation <[email protected]>

# Calls the github2gerrit reusable workflow
# Calls the github2gerrit reusable workflow
name: call-github2gerrit-reusable-workflow

# yamllint disable-line rule:truthy
Expand All @@ -25,7 +25,7 @@ jobs:
permissions:
contents: read
pull-requests: write
uses: askb/github2gerrit/.github/workflows/github2gerrit.yaml@main
uses: lfit/github2gerrit/.github/workflows/github2gerrit.yaml@main
with:
GERRIT_KNOWN_HOSTS: ${{ vars.GERRIT_KNOWN_HOSTS }}
GERRIT_SSH_USER_G2G: ${{ vars.GERRIT_SSH_USER_G2G }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/github2gerrit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ jobs:
git --no-pager log --graph --all --decorate --pretty=oneline -n5

- name: Install SSH Key
uses: shimataro/ssh-key-action@d4fffb50872869abe2d9a9098a6d9c5aa7d16be4 # v2.7.0
uses: shimataro/ssh-key-action@d4fffb50872869abe2d9a9098a6d9c5aa7d16be4 # v2.7.0
with:
key: ${{ secrets.GERRIT_SSH_PRIVKEY_G2G }}
name: "id_rsa"
Expand Down
134 changes: 66 additions & 68 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The action extracts the commits from a GitHub pull-request and submits them to a
## Pre-requisites

1. GitHub replication is set up on the Gerrit repository over SSH. Refer to the [Gerrit replication configuration setup guide](https://docs.releng.linuxfoundation.org/en/latest/infra/gerrit.html) maintained by the Linux Foundation release engineering team. This also requires creating ssh-keypair
and [registering the SSH keys](https://docs.releng.linuxfoundation.org/en/latest/gerrit.html#register-key-gerrit) with Gerrit.
and [registering the SSH keys](https://docs.releng.linuxfoundation.org/en/latest/gerrit.html#register-key-gerrit) with Gerrit.
2. Create a user account on GitHub with permissions to submit changes to Gerrit and ensure it is added to the GitHub organization or repository as a member.
3. Use a [.gitreview](https://docs.opendev.org/opendev/git-review/latest/installation.html#gitreview-file-format) file point to the Gerrit server and repository. If this not alternatively pass the GERRIT_SERVER or GERRIT_PROJECT as inputs to the workflow.

Expand All @@ -21,24 +21,24 @@ The action and workflow are written with bash scripts using well known Git SCM t

## Caveats - Future Improvements

- Commits in a pull request are squashed into a single commit before submitting the change request to Gerrit.
- Code review comments on Gerrit will not be updated back on the pull request, requiring developers to follow up on the Gerrit change request URL.
- Commits in a pull request are squashed into a single commit before submitting the change request to Gerrit.
- Code review comments on Gerrit will not be updated back on the pull request, requiring developers to follow up on the Gerrit change request URL.

## Required Inputs

- `GERRIT_KNOWN_HOSTS`: Known host of the Gerrit repository.
- `GERRIT_SSH_PRIVKEY_G2G`: SSH private key pair (The private key has to be added to the Gerrit user's account settings. Gerrit -> User Settings).
- `GERRIT_SSH_USER_G2G`: Gerrit server username (Required to connect to Gerrit).
- `GERRIT_SSH_USER_G2G_EMAIL`: Email of the Gerrit user.
- `GERRIT_KNOWN_HOSTS`: Known host of the Gerrit repository.
- `GERRIT_SSH_PRIVKEY_G2G`: SSH private key pair (The private key has to be added to the Gerrit user's account settings. Gerrit -> User Settings).
- `GERRIT_SSH_USER_G2G`: Gerrit server username (Required to connect to Gerrit).
- `GERRIT_SSH_USER_G2G_EMAIL`: Email of the Gerrit user.

## Optional Inputs

- `FETCH_DEPTH`: fetch-depth of the clone repo. (Default: 10)
- `GERRIT_PROJECT`: Gerrit project repository (Default read from .gitreview).
- `GERRIT_SERVER`: Gerrit server FQDN (Default read from .gitreview).
- `GERRIT_SERVER_PORT`: Gerrit server port (Default: 29418)
- `ORGANIZATION`: The GitHub Organization or Project.
- `REVIEWER_EMAIL`: Committers' email list (comma-separated list without spaces).
- `FETCH_DEPTH`: fetch-depth of the clone repo. (Default: 10)
- `GERRIT_PROJECT`: Gerrit project repository (Default read from .gitreview).
- `GERRIT_SERVER`: Gerrit server FQDN (Default read from .gitreview).
- `GERRIT_SERVER_PORT`: Gerrit server port (Default: 29418)
- `ORGANIZATION`: The GitHub Organization or Project.
- `REVIEWER_EMAIL`: Committers' email list (comma-separated list without spaces).

## Full Example Usage with Composite Action

Expand All @@ -53,41 +53,40 @@ name: call-github2gerrit-composite-action

# yamllint disable-line rule:truthy
on:
pull_request_target:
types: [opened, reopened, edited, synchronize]
branches:
- master
- main
pull_request_target:
types: [opened, reopened, edited, synchronize]
branches:
- master
- main

jobs:
call-in-g2g-workflow:
permissions:
contents: read
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
- name: "Call the askb/github2gerrit composite action"
id: gerrit-upload
uses: askb/github2gerrit@main
with:
FETCH_DEPTH: 10
GERRIT_KNOWN_HOSTS: ${{ vars.GERRIT_KNOWN_HOSTS }}
GERRIT_SERVER: ${{ vars.GERRIT_SERVER }}
GERRIT_SERVER_PORT: "29418"
GERRIT_SSH_PRIVKEY_G2G: ${{ secrets.GERRIT_SSH_PRIVKEY_G2G }}
GERRIT_SSH_USER_G2G: ${{ vars.GERRIT_SSH_USER_G2G }}
GERRIT_SSH_USER_G2G_EMAIL: ${{ vars.GERRIT_SSH_USER_G2G_EMAIL }}
ORGANIZATION: ${{ vars.ORGANIZATION }}

- name: "Output change-number and change URL"
shell: bash
run: |
echo "Change URL: ${{ steps.change_num.outputs.GERRIT_CHANGE_REQUEST_URL }}"
echo "Change number: ${{ steps.change_num.outputs.GERRIT_CHANGE_REQUEST_NUMBER }}"

call-in-g2g-workflow:
permissions:
contents: read
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
- name: "Call the lfit/github2gerrit composite action"
id: gerrit-upload
uses: lfit/github2gerrit@main
with:
FETCH_DEPTH: 10
GERRIT_KNOWN_HOSTS: ${{ vars.GERRIT_KNOWN_HOSTS }}
GERRIT_SERVER: ${{ vars.GERRIT_SERVER }}
GERRIT_SERVER_PORT: "29418"
GERRIT_SSH_PRIVKEY_G2G: ${{ secrets.GERRIT_SSH_PRIVKEY_G2G }}
GERRIT_SSH_USER_G2G: ${{ vars.GERRIT_SSH_USER_G2G }}
GERRIT_SSH_USER_G2G_EMAIL: ${{ vars.GERRIT_SSH_USER_G2G_EMAIL }}
ORGANIZATION: ${{ vars.ORGANIZATION }}

- name: "Output change-number and change URL"
shell: bash
run: |
echo "Change URL: ${{ steps.change_num.outputs.GERRIT_CHANGE_REQUEST_URL }}"
echo "Change number: ${{ steps.change_num.outputs.GERRIT_CHANGE_REQUEST_NUMBER }}"
```

## Full Example usage with reusable workflow
Expand All @@ -103,32 +102,31 @@ name: call-github2gerrit-reusable-workflow

# yamllint disable-line rule:truthy
on:
workflow_dispatch:
pull_request_target:
types: [opened, reopened, edited, synchronize]
branches:
- master
- main
workflow_dispatch:
pull_request_target:
types: [opened, reopened, edited, synchronize]
branches:
- master
- main

concurrency:
# yamllint disable-line rule:line-length
group: ${{ github.workflow }}-${{ github.run_id }}
cancel-in-progress: true
# yamllint disable-line rule:line-length
group: ${{ github.workflow }}-${{ github.run_id }}
cancel-in-progress: true

jobs:
call-in-g2g-workflow:
permissions:
contents: read
pull-requests: write
uses: askb/github2gerrit/.github/workflows/github2gerrit.yaml@main
with:
GERRIT_KNOWN_HOSTS: ${{ vars.GERRIT_KNOWN_HOSTS }}
GERRIT_SSH_USER_G2G: ${{ vars.GERRIT_SSH_USER_G2G }}
GERRIT_SSH_USER_G2G_EMAIL: ${{ vars.GERRIT_SSH_USER_G2G_EMAIL }}
ORGANIZATION: ${{ vars.ORGANIZATION }}
secrets:
GERRIT_SSH_PRIVKEY_G2G: ${{ secrets.GERRIT_SSH_PRIVKEY_G2G }}

call-in-g2g-workflow:
permissions:
contents: read
pull-requests: write
uses: lfit/github2gerrit/.github/workflows/github2gerrit.yaml@main
with:
GERRIT_KNOWN_HOSTS: ${{ vars.GERRIT_KNOWN_HOSTS }}
GERRIT_SSH_USER_G2G: ${{ vars.GERRIT_SSH_USER_G2G }}
GERRIT_SSH_USER_G2G_EMAIL: ${{ vars.GERRIT_SSH_USER_G2G_EMAIL }}
ORGANIZATION: ${{ vars.ORGANIZATION }}
secrets:
GERRIT_SSH_PRIVKEY_G2G: ${{ secrets.GERRIT_SSH_PRIVKEY_G2G }}
```

## Contributions
Expand Down