Automatically update wp-cli.md #2370
Conversation
.github/workflows/build-docs.yml
Outdated
| - master | ||
| pull_request: | ||
| branches: | ||
| - develop |
There was a problem hiding this comment.
We purposely do not update the docs off changes to develop as those items are not yet in a released version and thus the docs would conflict with whats actually in the plugin. You might consider removing this unless there's a precise reason to keep it?
There was a problem hiding this comment.
The only reason why I added that was to generate the artifact after creating the PR, I don't think there is any reason why we should update these docs when things are merged to develop. I'll push a commit shortly with what I think should be the "final" version of the action.
There was a problem hiding this comment.
@felipeelia looks like that change dropped develop and the generating of the ZIP artifact yeah?
- Remove executions on PRs - Remove artifact creation - Uncomment deployment to GH Pages
| - name: Set PHP version | ||
| uses: shivammathur/setup-php@v2 | ||
| with: | ||
| php-version: '7.4' | ||
| coverage: none | ||
| tools: prestissimo, composer:v1 | ||
| ini-values: memory_limit=3G |
There was a problem hiding this comment.
I don't see the usage of composer in this workflow, and PHP 7.4 is shipped with ubuntu-latest. I'm wondering if we can remove this section?
There was a problem hiding this comment.
Good points @dinhtungdu!
- Composer is used by the wp package install command: https://github.com/wp-cli/package-command
- GH Actions have both PHP 7.4 and 8.0 available at this point. I think it will already use 8.0 by default but even if it is still using 7.4 it is just a matter of time to have 8.0 as the default. I'd rather force 7.4 until we are all sure EP is fully compatible with that version than risking it breaking. Also, we need that
memory_limit=3Ganyway because the package install command is a huge memory consumer.
There was a problem hiding this comment.
Thanks, then this is looking good to me! Note that I assume the cli-command-docs works as expected.
|
|
Description of the Change
Based on the work made for #2369, this PR is an attempt to automate the process.