Skip to content

liferay/liferay-portal / .claude/skills/pr-check

pr-check

Verified

Check that a PR is ready to be sent for review.

FileKindSize
SKILL.mdskill md36.5 KB
find_modules.shexecutablescript1.4 KB
references/testing.mdmarkdown5.4 KB
select_paths.shexecutablescript2.2 KB
select_validations.shexecutablescript1.1 KB
validations/branch/bean-param-util-getter.mdmarkdown6.6 KB
validations/branch/bnd-content.mdmarkdown15.2 KB
validations/branch/bnd-dsannotations-options.mdmarkdown9.1 KB
validations/branch/cache-field-usage.mdmarkdown13.9 KB
validations/branch/concurrent-mapper-hash-map-usage.mdmarkdown7.5 KB
validations/branch/html-escaping.mdmarkdown2.6 KB
validations/branch/pr-reviewer.mdmarkdown6.6 KB
validations/branch/redundant-assert-message.mdmarkdown13.5 KB
validations/branch/required-configuration-policy.mdmarkdown7.9 KB
validations/branch/service-holder-usage.mdmarkdown8.3 KB
validations/branch/service-registration.mdmarkdown3.7 KB
validations/branch/source-format.mdmarkdown4.1 KB
validations/branch/startup-sync-usage.mdmarkdown10.6 KB
validations/branch/transaction-usage.mdmarkdown4.0 KB
validations/branch/unused-project-dependencies.mdmarkdown18.5 KB
validations/portal/baseline.mdmarkdown14.0 KB
validations/portal/cross-module-compile.mdmarkdown7.9 KB
validations/portal/full-portal-build.mdmarkdown1.4 KB
validations/portal/go-generate.mdmarkdown2.8 KB
validations/portal/go-source-format.mdmarkdown1.9 KB
validations/portal/helm-unit-test-order.mdmarkdown1.4 KB
validations/portal/instance-wrapper-build.mdmarkdown656 B
validations/portal/java-unit-test.mdmarkdown6.7 KB
validations/portal/javascript-unit-test.mdmarkdown7.7 KB
validations/portal/module-registration.mdmarkdown7.8 KB
validations/portal/per-module-compile.mdmarkdown10.4 KB
validations/portal/portlet-title.mdmarkdown1.1 KB
validations/portal/poshi-syntax.mdmarkdown336 B
validations/portal/pql-validation.mdmarkdown516 B
validations/portal/rest-builder.mdmarkdown938 B
validations/portal/service-builder.mdmarkdown1.6 KB
validations/portal/structural-smoke.mdmarkdown3.9 KB
validations/portal/theme-build.mdmarkdown2.0 KB
validations/workspaces/generated-file.mdmarkdown2.5 KB
validations/workspaces/source-format.mdmarkdown2.0 KB
validations/workspaces/workspace-compile.mdmarkdown1.8 KB
validations/workspaces/workspace-java-unit-test.mdmarkdown1.7 KB
validations/workspaces/workspace-javascript-unit-test.mdmarkdown1.9 KB

validations/portal/go-generate.md

View on GitHub
# Go Generate

Runs `go generate` and fails when that changes the committed CRD, which means it has drifted from the API types that produce it. Drift has three sources: a type or a `+kubebuilder:` marker changed without a regeneration, a `go.mod` bump changed the controller-gen version stamped into the CRD, or the source formatter release `go_build.sh` uses disagrees with the one the repository resolves, as in commit `f3d6fcaa`.

## Match

`^cloud/operator/|^cloud/helm/dxp-operator/crds/`

## Command

Regenerate, then assert the working tree is unchanged:

```bash
(cd "${REPO_ROOT}/cloud/operator" && ./go_build.sh generate)
(cd "${REPO_ROOT}" && git status --porcelain)
```

A nonempty `git status --porcelain` is drift and fails this validation; the Autocommit step captures it. Report the drifted paths in the failure note, and say which of the three sources above they point to — a changed `controller-gen.kubebuilder.io/version` line is a generator bump, a reflowed `description` is formatter skew, and anything else is a stale CRD.

Only the CRD is observable here. `go generate` also rewrites `zz_generated.deepcopy.go`, which `cloud/.gitignore` excludes, so drift in the deepcopy methods never reaches `git status`; the compiler catches that one instead.

The script needs `java`, a Go toolchain, and network access; it downloads the source formatter to `${HOME}/.liferay/source-formatter` on first use. When any of those is missing the script exits nonzero — record that as a failure to run rather than as drift, since the two call for different fixes.

Do not set `LIFERAY_GO_BUILD_SKIP_SOURCE_FORMATTER=true` here. The committed CRD is source-formatter output, so skipping that step reports the whole file as drift.

## Autocommit

When `git status --porcelain` is nonempty after the regen, stage all changes (`git add --all`) and create a commit titled `<TICKET> go generate`, matching the existing convention (`LCD-52889 go generate`).

When the commit fails, record the failure and continue to the next validation.

## Notes

Run with the drift validations, **before** Source Format, so the formatter sees the regenerated CRD and owns the final bytes. Running it after would let `ant format-source-current-branch` reformat a CRD this validation just committed.

This overlaps the "Check generated files are up to date" step in `ci-reusable-test-cloud-operator.yaml`, deliberately — it surfaces the same failure locally, before the push. The overlap is not total: its caller, `ci-test-cloud-operator.yaml`, triggers only on `cloud/operator/**` and on the two workflow files themselves, so a change confined to the CRD never reaches it. The job is also gated on the `cloudnative-team/liferay-portal` repository, so it does not run everywhere the skill does.

## Time Estimate

~1-2 min, plus a source formatter download the first time, when `${HOME}/.liferay` holds no cached release.
receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementationStars: 323kUpdated Claude CodeCodexVerifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 323kUpdated Claude CodeCodexVerifiedInstall
using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallbackStars: 323kUpdated Claude CodeCodexVerifiedInstall
verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysStars: 323kUpdated Claude CodeCodexVerifiedInstall