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

Jump to bottom

Run PHPCS in CI for FSE plugin #43458

Merged
merged 24 commits into from
Jun 19, 2020
Merged

Run PHPCS in CI for FSE plugin #43458

Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
2ecbec3
Add phpcs step to GH action
noahtallen Jun 18, 2020
80bdb45
This should fail the action
noahtallen Jun 18, 2020
f1a512f
Run phpcs on all files in FSE directory
noahtallen Jun 18, 2020
6c9c0eb
correct syntax
noahtallen Jun 18, 2020
09bdbc7
use right token
noahtallen Jun 18, 2020
d560633
use outputs
noahtallen Jun 18, 2020
ec2bb59
Try fromJSON
noahtallen Jun 18, 2020
1d8b816
fix syntax
noahtallen Jun 18, 2020
d6d196a
jq
noahtallen Jun 18, 2020
28ecfff
bash syntax
noahtallen Jun 18, 2020
9c9d563
try bad js
noahtallen Jun 18, 2020
908809d
Add check for changed files
noahtallen Jun 18, 2020
24fcb81
Try better echo of changed files
noahtallen Jun 18, 2020
a679a24
try more stuff
noahtallen Jun 18, 2020
03c5faa
better syntax
noahtallen Jun 18, 2020
df2bdb2
join from JSON
noahtallen Jun 18, 2020
5271dda
Use join everywhere
noahtallen Jun 18, 2020
f838d3e
Remove extra $
noahtallen Jun 18, 2020
0998920
try another
noahtallen Jun 18, 2020
de372ca
more stuff
noahtallen Jun 18, 2020
634568d
Add step for no changes foundM
noahtallen Jun 18, 2020
d4d52bb
Remove badly formatted files
noahtallen Jun 18, 2020
bf74d5c
test yarn change
noahtallen Jun 18, 2020
65261ce
remove yarn change
noahtallen Jun 18, 2020
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
34 changes: 32 additions & 2 deletions .github/workflows/full-site-editing-plugin.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
on:
pull_request:
# only trigger this workflow if FSE plugin files have been modified
# only trigger this workflow if FSE plugin files have been modified, or if packages have been updated.
paths:
- 'apps/full-site-editing/full-site-editing-plugin/**'
- 'apps/full-site-editing/**'
Copy link
Member

Choose a reason for hiding this comment

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

Not sure if we should build and sync diff creation for things outside of actual plugin folder. 🤔 It probably won't cause issues since we only merge version bump PRs anyway. Another option would be to isolate the changes here in a separate workflow file with these broader matchers.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That might be possible. IMO, we should be running:

  • yarn build
  • phpunit
  • phpcs

to any change in apps/full-site-editing (e.g. to pick up on config changes). And on changes to yarn-lock.

IMO the sync diff is the exception 🤔 I wonder if we can restrict a job based on the path itself.

Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure if we should build and sync diff creation for things outside of actual plugin folder. It probably won't cause issues since we only merge version bump PRs anyway.

Yeah, and there's currently not a lot of files in apps/full-site-editing/ (outside of apps/full-site-editing/full-site-editing-plugin), so the overhead shouldn't be too bad.

Another option would be to isolate the changes here in a separate workflow file with these broader matchers.

That might make sense in the long run.

Personally, I wouldn't block merging this PR on that -- I think it's important to get PHPCS into CI, and we can tweak and iterate how we do it later.

Copy link
Member

Choose a reason for hiding this comment

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

IMO the sync diff is the exception 🤔 I wonder if we can restrict a job based on the path itself.

Afaik that hasn't been introduced in GH actions proper yet, although I've seen some 3rd party actions for it (I would rather avoid that dependency).

Copy link
Member

Choose a reason for hiding this comment

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

I don't consider this a blocker either, just a possible future improvement.

- 'yarn.lock'
Copy link
Member

Choose a reason for hiding this comment

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

It turns out that this match is too broad and it will trigger on PRs that are not related to FSE plugin. For example see D45192-code.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'll file a PR to remove it 👍

Copy link
Contributor

Choose a reason for hiding this comment

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

#43480


name: FSE plugin

Expand Down Expand Up @@ -109,3 +110,32 @@ jobs:
- name: Run phpunit command
run: yarn test:php
working-directory: apps/full-site-editing

phpcs:
name: Run phpcs
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@master

- name: Run composer
uses: nick-zh/composer-php@master
with:
action: 'install'

- name: Get changed files
id: changes
uses: lots0logs/gh-action-get-changed-files@2.1.4
with:
token: ${{ secrets.GITHUB_TOKEN }}

- name: Displaying changed files
run: echo ${{ join( fromJson( steps.changes.outputs.all ) ) }}

- name: Execute phpcs on changed files
run: ./vendor/bin/phpcs --standard=apps/phpcs.xml ${{ join( fromJson( steps.changes.outputs.all ), ' ' ) }}
if: ${{ steps.changes.outputs.all != '' }}

- name: No changes found
run: echo "No changes found to check!"
if: ${{ steps.changes.outputs.all == '' }}