summaryrefslogtreecommitdiffstatshomepage
path: root/README.md
Commit message (Collapse)AuthorAge
* Build/Test Tools: Support older MariaDB versions in local Docker environment.Jonathan Desrosiers2024-12-04
| | | | | | | | | | | | | Older versions of MariaDB did not contain the `mariadb-admin` command. This command is configured as the `healthcheck` used by the local Docker environment to confirm that the database container has successfully started and is reporting as “healthy”. The current result is a failure when starting the environment while using one of the affected older versions. For MariaDB versions 10.3 and earlier, the `mysqladmin` command was used instead. Since WordPress still technically supports back to MariaDB 5.5, the local environment should support running these versions. This updates the environment configuration to take this into account when performing a `healthcheck` test. The README file is also updated to reflect that the same workaround added in [57568] for MySQL <= 5.7 is required when using MariaDB 5.5 on an Apple silicon machine. Props johnbillion. See #62221. git-svn-id: https://develop.svn.wordpress.org/trunk@59484 602fd350-edb4-49c9-b593-d223f7449a82
* Docs: Correct the spelling of silicon in the local development environment ↵John Blackbourn2024-11-14
| | | | | | | | | readme. See #62281 git-svn-id: https://develop.svn.wordpress.org/trunk@59405 602fd350-edb4-49c9-b593-d223f7449a82
* Build/Test Tools: Add script for generating code coverage report.Jonathan Desrosiers2024-11-05
| | | | | | | | | | | This adds documentation for how to generate code coverage reports to the README.md file. `test:coverage` has also been added as an npm script to make it easier to generate a report using the local Docker environment. The script will generate an HTML, PHP, and text report file. Props pbearne, hellofromTonya, netweb. Fixes #53414. git-svn-id: https://develop.svn.wordpress.org/trunk@59356 602fd350-edb4-49c9-b593-d223f7449a82
* Docs: Fix various typos and spelling mistakes.Pascal Birchler2024-04-12
| | | | | | | Props swissspidy, jucaduca, sergeybiryukov. See #60699. git-svn-id: https://develop.svn.wordpress.org/trunk@57987 602fd350-edb4-49c9-b593-d223f7449a82
* Build/Test Tools: Fix bug pulling local environment containers on Apple ↵Jonathan Desrosiers2024-02-08
| | | | | | | | | | | | | | | silicone. The MySQL Docker containers for versions 5.7 and below do not support recent Apple silicone chips. Previously this was fixed by including `amd64/` as a prefix to the image name in the `docker-compose.yml` file (see [54096]). However, this stopped working after recent updates to Docker Desktop. This changeset removes the `amd64/` prefix for the image used as the database container and raises the default version of MySQL in the local development environment to the current LTS version (8.0). Because this version is still maintained, there are `arm64` containers available to use. This also documents a new workaround for contributors looking to run the local Docker environment using MySQL 5.7 or earlier, which entails creating a small `docker-compose.override.yml`. Props bernhard-reiter, johnbillion, afragen, huzaifaalmesbah. Fixes #59930. git-svn-id: https://develop.svn.wordpress.org/trunk@57568 602fd350-edb4-49c9-b593-d223f7449a82
* Build/Test Tools: Raise minimum required version of Node.js/npm.Jonathan Desrosiers2023-12-20
| | | | | | | | | | | | | This bumps the minimum required version of Node.js/npm from 16.19.1 and 8.19.3 to 20.10.0 and 10.2.3. Since 20.10.0 is the latest 20.x version of Node.js, the `check-latest` option has been enabled for `actions/setup-node` in GitHub Actions workflows. This performs an additional external call to the Node.js API confirming the latest version is installed on the runner for use. In testing, it seems that 20.10.0 was not consistently deployed to all runner machines in use. This should be removed in the near future when the version of Node.js is reliably above the new minimum requirement. The Gutenberg repository has also been updated to use the same values for `engines`. Props jorbin, joemcgill, swissspidy, benharri, dhrupo, flootr, gziolo, noahtallen. See #59663. git-svn-id: https://develop.svn.wordpress.org/trunk@57212 602fd350-edb4-49c9-b593-d223f7449a82
* Build/Test Tools: Add a readme note on passing parameters into the PHPUnit ↵Sergey Biryukov2023-11-24
| | | | | | | | | | | tests. Follow-up to [45745], [47743]. Props pbearne, costdev. Fixes #59624. git-svn-id: https://develop.svn.wordpress.org/trunk@57134 602fd350-edb4-49c9-b593-d223f7449a82
* Build/Test Tools: Update the README file to reflect new Node.js/npm versions.Jonathan Desrosiers2023-08-11
| | | | | | | | | Follow up to [56378]. Props dantovbein, hbhalodia. Fixes #59071. See #56658. git-svn-id: https://develop.svn.wordpress.org/trunk@56387 602fd350-edb4-49c9-b593-d223f7449a82
* Text Changes: Typo fix in `README.md`.Jb Audras2023-04-26
| | | | | | | | | | Follow-up to [47752]. Props neychok. Fixes #58177. git-svn-id: https://develop.svn.wordpress.org/trunk@55690 602fd350-edb4-49c9-b593-d223f7449a82
* Build/Test Tools: Add a devcontainer for Codespaces support.Helen Hou-Sandi2023-02-10
| | | | | | | | | | | | | This adds a devcontainer configuration tested for use with GitHub Codespaces. It is currently built on top of the Docker `wordpress` image for initial trial purposes. We should eventually be using our own containers to fully own the environment. This should be considered a beta run to get a sense of how well cloud dev containers work for core contributors, in particular at contributor day events with limited bandwidth and mobile devices. Props samruddhikhandale, dinhtungdu, helen, craiglpeters, sam1el, wirecat. See #57187. git-svn-id: https://develop.svn.wordpress.org/trunk@55303 602fd350-edb4-49c9-b593-d223f7449a82
* General: Correctly refer to “npm” and “Node.js”.Jonathan Desrosiers2022-10-19
| | | | | | | | This update all references to npm and Node.js to their correct spelling. Fixes #56816. git-svn-id: https://develop.svn.wordpress.org/trunk@54650 602fd350-edb4-49c9-b593-d223f7449a82
* Build/Test Tools: Note the versions of NodeJS and npm supported.Jonathan Desrosiers2022-10-04
| | | | | | | | | This adds a note to the Getting Started section of the `README.md` file mentioning that NodeJS `14.x` and npm `6.x` is currently required to spin up a development environment. Props elpanda13gmailcom, robinwpwebdeveloper, jakariaistauk, hztyfoon, seakashdiu, rudlinkon, fuadragib. Fixes #55903. git-svn-id: https://develop.svn.wordpress.org/trunk@54375 602fd350-edb4-49c9-b593-d223f7449a82
* Docs: Miscellaneous inline documentation improvements.John Blackbourn2022-08-11
| | | | | | | See #55646 git-svn-id: https://develop.svn.wordpress.org/trunk@53878 602fd350-edb4-49c9-b593-d223f7449a82
* Build/Test Tools: Remove remaining Travis CI references.Dominik Schilling2021-04-10
| | | | | | | | | | | | * Remove `travis:` tasks in Gruntfile.js. * Remove status badge in README.md that comes from Travis CI via shields.io. * Remove Travis CI related skipping in the `WP_UnitTestCase_Base::skipOnAutomatedBranches()` test method and related Docker environment variables. Props johnbillion, SergeyBiryukov, ocean90. See #52161. Fixes #52666. git-svn-id: https://develop.svn.wordpress.org/trunk@50697 602fd350-edb4-49c9-b593-d223f7449a82
* Build/Test Tools: Switch back to running the PHPUnit test suite against the ↵John Blackbourn2021-02-26
| | | | | | | | | | | | | | | | | | `src` directory instead of `build`. Some PHPUnit tests were concerned with the state of files in the `build` directory. In order to allow the tests to run without requiring a build to be run first, these have been moved into assertions that run after the build step (and therefore cause it to fail if they do not pass), or into QUnit tests as necessary. Various other PHPUnit tests implictly depend on built JavaScript files being present. These files are now touched during the test setup to avoid PHP warnings if the `build` files are not present. The `wp-tests-config-sample.php` file and the GitHub Actions configuration have also been changed so `ABSPATH` uses `src` instead of `build`, therefore allowing the PHPUnit tests to be run without a build having to be run first. This means all new local installations of WordPress will use `src` for PHPUnit testing. If you would like to switch your existing installation over then change the location of `ABSPATH` in `wp-tests-config.php` to point to `src` instead of `build`. Props peterwilsoncc, iandunn, gziolo, desroj, johnbillion Fixes #51734 See #45863 git-svn-id: https://develop.svn.wordpress.org/trunk@50441 602fd350-edb4-49c9-b593-d223f7449a82
* Docs: Clarify the instructions on starting the local environment for the ↵Sergey Biryukov2021-01-12
| | | | | | | | | | | first time. This adds a mention of cloning the repository before running the npm commands in the terminal. Props justinahinon. Fixes #52278. See #51414. git-svn-id: https://develop.svn.wordpress.org/trunk@49957 602fd350-edb4-49c9-b593-d223f7449a82
* Docs: Revert an accidental revert of this package name.John Blackbourn2020-11-14
| | | | | | | See #51414, #50768 git-svn-id: https://develop.svn.wordpress.org/trunk@49598 602fd350-edb4-49c9-b593-d223f7449a82
* Docs: Various docblock corrections and improvements.John Blackbourn2020-11-14
| | | | | | | See #50768 git-svn-id: https://develop.svn.wordpress.org/trunk@49597 602fd350-edb4-49c9-b593-d223f7449a82
* Docs: Correct the Chocolatey package name for Node in the local environment ↵John Blackbourn2020-11-14
| | | | | | | | | | | setup instructions. Props pbearne See #51414 git-svn-id: https://develop.svn.wordpress.org/trunk@49594 602fd350-edb4-49c9-b593-d223f7449a82
* Build/Test Tools: Further enhancements to the local development environment ↵John Blackbourn2020-05-03
| | | | | | | | | | readme. Props desrosj, donmhico See #50058 git-svn-id: https://develop.svn.wordpress.org/trunk@47752 602fd350-edb4-49c9-b593-d223f7449a82
* Build/Test Tools: Add information regarding the default credentials for the ↵John Blackbourn2020-05-02
| | | | | | | | | | local development environment to the project readme. Props bookdude13 Fixes #49273 git-svn-id: https://develop.svn.wordpress.org/trunk@47744 602fd350-edb4-49c9-b593-d223f7449a82
* Build/Test Tools: Add more comprehensive instructions to the readme for the ↵John Blackbourn2020-05-02
| | | | | | | | local development environment. See #50058 git-svn-id: https://develop.svn.wordpress.org/trunk@47743 602fd350-edb4-49c9-b593-d223f7449a82
* Docs: Fix typo in `README.md`.Sergey Biryukov2019-11-20
| | | | | | | Props dkarfa. Fixes #48737. git-svn-id: https://develop.svn.wordpress.org/trunk@46752 602fd350-edb4-49c9-b593-d223f7449a82
* Build Tools: Add a WordPress Development Environment.Gary Pendergast2019-08-05
This commit adds the first iteration of a Docker-based config for setting up a local WordPress development environment. Props pento, noisysocks, mcsf, pbearne, isabel_brison. See #47767. git-svn-id: https://develop.svn.wordpress.org/trunk@45745 602fd350-edb4-49c9-b593-d223f7449a82
generated by cgit v1.2.3 (git 2.39.1) at 2025-04-30 02:47:39 +0000