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

Feat: Add support single commits and PR body and tittle as commit message #4

Merged
merged 2 commits into from
Aug 14, 2024

Conversation

askb
Copy link
Contributor

@askb askb commented Aug 1, 2024

  • Each commit in the pull request is processed individually as a
    single commit before submitting to Gerrit repository. This option
    allows you to preserve git history. This requires inputs.SUBMIT_SINGLE_COMMITS to be set to 'true'
    from the caller.

  • Remove extra inputs. Gerrit server and port and the project must be read
    from .gitreview file. Composite actions are limited on
    the number of inputs that can be passed to 10.

  • Support USE_PR_AS_COMMIT flag, allows commit message to be
    replaced the pull request body and title.
    Note: the 50/72 rule of the title and body needs to be taken
    care of by the developer or the pre-commit verification would fail.

  • Comment the PR URL link along with the workflow run URL on the
    Gerrit change request using ssh gerrit review CLI. This is
    useful to Jenkins jobs to query comments on the change and search
    for PR-### URL therefore allow developer comments to be sync back
    to the pull request on Github.

  • Prefix the git-review topic with the project name followed by
    PR-### to ensure the same topic is not overused from different projects
    under the same organization.

  • Update docs and examples caller workflows accordingly.

Copy link
Member

@tykeal tykeal left a comment

Choose a reason for hiding this comment

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

Minor typo in the first commit along with a note on future feature needs

.github/workflows/github2gerrit.yaml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
- Support USE_PR_AS_COMMIT flag, allows commit message to be
  replaced the pull request body and tittle.
  Note: the 50/72 rule of the title and body needs to be taken
  care of by the developer or the pre-commit verify would fail.

- Comment the PR URL link alone with the workflow run URL on the
  Gerrit change request using `ssh gerrit review` CLI. This is
  useful to Jenkins jobs to query comments on the change and search
  for PR-### URL therefore allow developer comments to be sync back
  to the pull request on Github.

- Prefix the git-review topic with the project name followed by
  PR-### to ensure same topic does not overused from diff projects
  under the same organization.

- Update docs and examples caller workflows accordingly.

Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
Each commit in the pull request are processed individually as a
single commit before submitting to Gerrit repository. This option
allows you to preserve git history.

This requires `inputs.SUBMIT_SINGLE_COMMITS` to be set to 'true'
from the caller.

Remove extra inputs. Gerrit server and port and project has be read
from .gitreview file. Composite actions have a limitation on
the number of the inputs that can be passed to 10.

Update doc example with new feat options.

Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
Copy link
Contributor Author

@askb askb left a comment

Choose a reason for hiding this comment

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

Update the review comments and fixed the type. Thanks for the review.

@tykeal tykeal merged commit e4cf2f8 into lfit:main Aug 14, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants