Skip to content

Commit aaa0999

Browse files
Merge pull request #11 from MacPaw/cursor/development-environment-setup-989b
Add AGENTS.md and fix deprecated GitHub Actions
2 parents 43b9a5b + cef5e79 commit aaa0999

File tree

4 files changed

+38
-9
lines changed

4 files changed

+38
-9
lines changed

.github/workflows/ci.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ jobs:
2626
name: PHP ${{ matrix.php }} Symfony ${{ matrix.symfony-versions }} ${{ matrix.description }}
2727
steps:
2828
- name: Checkout
29-
uses: actions/checkout@v2
29+
uses: actions/checkout@v4
3030

31-
- uses: actions/cache@v2
31+
- uses: actions/cache@v4
3232
with:
3333
path: ~/.composer/cache/files
3434
key: ${{ matrix.php }}-${{ matrix.symfony-versions }}
@@ -44,10 +44,10 @@ jobs:
4444

4545
- name: Set composer cache directory
4646
id: composer-cache
47-
run: echo "::set-output name=dir::$(composer config cache-files-dir)"
47+
run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
4848

4949
- name: Cache composer
50-
uses: actions/cache@v2.1.2
50+
uses: actions/cache@v4
5151
with:
5252
path: ${{ steps.composer-cache.outputs.dir }}
5353
key: ${{ runner.os }}-${{ matrix.php }}-${{ matrix.symfony-versions }}-composer-${{ hashFiles('composer.json') }}

.github/workflows/security.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
runs-on: ubuntu-latest
1010
steps:
1111
- name: Checkout
12-
uses: actions/checkout@v2
12+
uses: actions/checkout@v4
1313

1414
- name: Setup PHP
1515
uses: shivammathur/setup-php@v2

.github/workflows/static_analyse.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
runs-on: ubuntu-latest
1010
steps:
1111
- name: Checkout
12-
uses: actions/checkout@v2
12+
uses: actions/checkout@v4
1313

1414
- name: Setup PHP
1515
uses: shivammathur/setup-php@v2
@@ -25,7 +25,7 @@ jobs:
2525
runs-on: ubuntu-latest
2626
steps:
2727
- name: Checkout
28-
uses: actions/checkout@v2
28+
uses: actions/checkout@v4
2929

3030
- name: Setup PHP
3131
uses: shivammathur/setup-php@v2
@@ -41,7 +41,7 @@ jobs:
4141
runs-on: ubuntu-latest
4242
steps:
4343
- name: Checkout
44-
uses: actions/checkout@v2
44+
uses: actions/checkout@v4
4545

4646
- name: Setup PHP
4747
uses: shivammathur/setup-php@v2
@@ -57,7 +57,7 @@ jobs:
5757
runs-on: ubuntu-latest
5858
steps:
5959
- name: Checkout
60-
uses: actions/checkout@v2
60+
uses: actions/checkout@v4
6161

6262
- name: Setup PHP
6363
uses: shivammathur/setup-php@v2

AGENTS.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# AGENTS.md
2+
3+
## Cursor Cloud specific instructions
4+
5+
This is a **PHP Symfony Bundle library** (`macpaw/symfony-deprecated-routes`), not a standalone application. There is no server to start or database to connect to.
6+
7+
### Prerequisites
8+
9+
- PHP >= 8.1 (8.3 recommended) with extensions: mbstring, xml, curl, zip, intl, dom
10+
- Composer
11+
12+
### Key commands
13+
14+
| Task | Command |
15+
|---|---|
16+
| Install dependencies | `composer install` |
17+
| Run tests | `vendor/bin/phpunit` |
18+
| Lint (code style) | `vendor/bin/phpcs` |
19+
| Static analysis | `vendor/bin/phpstan analyse` |
20+
| Validate composer.json | `composer validate` |
21+
22+
### Notes
23+
24+
- No `composer.lock` is committed — `composer install` resolves latest compatible versions each time.
25+
- The `validate` script in `composer.json` shadows the `composer validate` command; Composer warns about this but it's harmless.
26+
- PHPStan runs at `level: max` — see `phpstan.neon` for excluded paths.
27+
- phpcs uses PSR-12 plus custom rules — see `phpcs.xml.dist`.
28+
- Tests include both unit (`tests/Unit/`) and functional (`tests/Functional/`) suites using a test kernel at `Macpaw\SymfonyDeprecatedRoutes\Tests\App`.
29+
- Docker (`docker-compose.yaml`) is only for multi-PHP-version testing; not needed for standard development.

0 commit comments

Comments
 (0)