-
Notifications
You must be signed in to change notification settings - Fork 0
Take 2 specification #1
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
base: main
Are you sure you want to change the base?
Conversation
bordoni
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like where this is headed, potentially lets talk about avoiding non ZIP plugins/themes for now. Let packaging be something the plugin handles.
It prevents complexity from landing on TestFlow.
spec-take-2.md
Outdated
| ## Plugin/Theme Build Process | ||
|
|
||
| When a repository is cloned, TestFlow executes the following build steps: | ||
|
|
||
| ### Standard Build Steps | ||
| 1. **Initialize git submodules** recursively | ||
| 2. **If `package.json` exists**: Run `nvm use && npm ci && npm run build` | ||
| 3. **If `composer.json` exists**: Run `composer install --no-dev --quiet` | ||
|
|
||
| If any build step fails, TestFlow exits immediately with an error. | ||
|
|
||
| ### Special Case: `common` Directory | ||
| Some repositories (e.g., `the-events-calendar/the-events-calendar`, `the-events-calendar/event-tickets`) contain a `common` directory with shared code. If present: | ||
| 1. Initialize submodules recursively within `common` | ||
| 2. If `common/package.json` exists: Run `nvm use && npm ci && npm run build` in `common` | ||
| 3. If `common/composer.json` exists: Run `composer install --no-dev --quiet` in `common` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would completely skip this step for a initial MVP.
Work only with fully formed ZIPs.
spec-take-2.md
Outdated
| See the `testflow.json` example structure above for full format details. | ||
|
|
||
| ### Source Types | ||
| - **String**: GitHub repository reference (clone) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would rather see a WordPress source than a GitHub Repo.
For github repos, only if it looked for Released ZIPs.
This PR only adds a specification file defining the expected code behavior and API.
The specification file is the place where examples of the desired flow, APIs and outcomes are collected.
I'm welcoming feedback to sync on the specification before implementing anything.