Skip to content

Commit 19fc30e

Browse files
committed
fix: Improve CI configuration and documentation
This commit addresses several issues to improve the CI workflow and documentation: - **CI Workflow (`.github/workflows/ci.yml`):** - Removed redundant `milliseconds` input for the `test-action` job. - Added `php-version: 8.4` to the `test-action` job, ensuring compatibility with PHP 8.4 for testing purposes. - **Documentation (`README.md`):** - Corrected "Github" to "GitHub" for proper capitalization. - Updated wording to "Drupal codebase" for consistency. - Ensured code formatting for registry options (`ghcr` and `dockerhub`). - Clarified that `grumphp run` is executed on the "codebase". - Clarified that `phpstan` is run on the "codebase". - **Dependencies (`package.json`):** - Added `engines.node` to specify a minimum Node.js version of 24.0.0, ensuring compatibility with newer Node.js features used by the action.
1 parent 154b0ff commit 19fc30e

File tree

3 files changed

+9
-10
lines changed

3 files changed

+9
-10
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,7 @@ jobs:
5757
id: test-action
5858
uses: ./
5959
with:
60-
milliseconds: 2000
61-
62-
- name: Print Output
63-
id: output
64-
run: echo "${{ steps.test-action.outputs.time }}"
60+
php-version: 8.4
6561

6662
build:
6763
runs-on: ubuntu-latest

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Github action for DrupalQA
1+
# GitHub Action for DrupalQA
22

33
This action runs checks from [DrupalQA](https://github.com/hussainweb/drupalqa)
4-
on a Drupal code base. While you can directly use the Docker image with Github
4+
on a Drupal codebase. While you can directly use the Docker image with GitHub
55
Actions, this Action makes it simpler to specify and configure some of the
66
checks.
77

@@ -47,7 +47,7 @@ The options for each of these are described in the
4747
4848
### `registry`
4949

50-
The registry to use to download the image. Only 'ghcr' and 'dockerhub' are
50+
The registry to use to download the image. Only `ghcr` and `dockerhub` are
5151
supported. You probably don't need to change this option. It's only there to
5252
compare the performance and switch to DockerHub in case there is a problem with
5353
ghcr.io (which is unlikely). Default: `ghcr`.
@@ -160,7 +160,7 @@ checks: |
160160
tasks: []
161161
```
162162

163-
This runs `grumphp run` on the code base.
163+
This runs `grumphp run` on the codebase.
164164

165165
### phpstan
166166

@@ -175,7 +175,7 @@ checks: |
175175
paths: []
176176
```
177177

178-
This runs `phpstan` on the code base with the specified options. For the
178+
This runs `phpstan` on the codebase with the specified options. For the
179179
defaults to work, you must have a `phpstan.neon` configuration file in your
180180
codebase as
181181
[mentioned in the documentation](https://phpstan.org/user-guide/command-line-usage#running-without-arguments).

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@
2222
"exports": {
2323
".": "./dist/index.js"
2424
},
25+
"engines": {
26+
"node": ">=24.0.0"
27+
},
2528
"keywords": [
2629
"drupal",
2730
"docker",

0 commit comments

Comments
 (0)