wp-cli/export-command
2
0
Fork 0
mirror of https://hk.gh-proxy.com/https://github.com/wp-cli/profile-command.git synced 2025-08-21 06:39:02 +08:00
Code Issues Projects Packages Activity Actions

Regenerate README for general WP-CLI consumption

Browse source
This commit is contained in:
Daniel Bachhuber 2017-02-06 15:20:19 -08:00
parent d21d2d915b
commit aee079ef77
4 changed files with 66 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

35
.travis.yml Normal file
View file

@ -0,0 +1,35 @@
sudo: false
language: php
notifications:
email:
on_success: never
on_failure: change
branches:
only:
- master
php:
- 7.1
- 7.0
- 5.6
- 5.3
cache:
- composer
- $HOME/.composer/cache
env:
global:
- WP_CLI_BIN_DIR=/tmp/wp-cli-phar
matrix:
- WP_VERSION=latest
- WP_VERSION=trunk
before_script:
- composer validate
- bash bin/install-package-tests.sh
script: ./vendor/bin/behat --strict

48
README.md
View file

@ -1,11 +1,11 @@
runcommand/profile
==================
wp-cli/profile
==============
Quickly identify what's slow with WordPress.
[![runcommand premium](https://runcommand.io/wp-content/themes/runcommand-theme/bin/shields/runcommand-premium.svg)](https://runcommand.io/pricing/) [![version 0.3.0](https://runcommand.io/wp-content/themes/runcommand-theme/bin/shields/version-0-3-0.svg)](https://runcommand.io/2016/11/03/wp-profile-v0-3-0/) [![CircleCI](https://circleci.com/gh/runcommand/profile/tree/master.svg?style=svg&circle-token=d916e588bf7c8ac469a3bd01930cf9eed886debe)](https://circleci.com/gh/runcommand/profile/tree/master)
[![CircleCI](https://circleci.com/gh/wp-cli/profile/tree/master.svg?style=svg)](https://circleci.com/gh/wp-cli/profile/tree/master)
Quick links: [Overview](#overview) | [Using](#using) | [Installing](#installing) | [Support](#support)
Quick links: [Overview](#overview) | [Using](#using) | [Installing](#installing) | [Contributing](#contributing)
## Overview
@ -211,32 +211,40 @@ current theme.
## Installing
`wp profile` is available to [runcommand gold and silver subscribers](https://runcommand.io/pricing/), or you can purchase a single-seat updates and support subscription for [$129 per year](https://runcommand.memberful.com/checkout?plan=16079).
Installing this package requires WP-CLI v0.23.0 or greater. Update to the latest stable release with `wp cli update`.
Once you've signed up, you can [download the latest version](https://runcommand.memberful.com/account/downloads) from your account dashboard. Then, install `wp profile` with:
Once you've done so, you can install this package with `wp package install wp-cli/profile`.
```
$ wp package install profile.zip
```
## Contributing
If you have a Github developer seat, you can also run:
We appreciate you taking the initiative to contribute to this project.
```
$ wp package install git@github.com:runcommand/profile.git
```
Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.
See documentation for [alternative installation instructions](https://runcommand.io/to/require-file-wp-cli-yml/).
### Reporting a bug
## Support
Think you’ve found a bug? We’d love for you to help us get it fixed.
Support (either through Github issues or via email) is available to paying [runcommand](https://runcommand.io/) customers.
Before you create a new issue, you should [search existing issues](https://github.com/wp-cli/profile/issues?q=label%3Abug%20) to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.
Have access to [Sparks](https://github.com/runcommand/sparks/), the runcommand Github issue tracker? Feel free to [open a new issue](https://github.com/runcommand/sparks/issues/new). Keep in mind Sparks is semi-public (multiple companies have access to it); please use email support for anything that needs to be kept private.
Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [create a new issue](https://github.com/wp-cli/profile/issues/new) with the following:
Think you’ve found a bug? Before you create a new issue, you should [search existing issues](https://github.com/runcommand/sparks/issues?q=label%3Abug%20) to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version. Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [create a new issue](https://github.com/runcommand/sparks/issues/new) with description of what you were doing, what you saw, and what you expected to see.
1. What you were doing (e.g. "When I run `wp post list`").
2. What you saw (e.g. "I see a fatal about a class being undefined.").
3. What you expected to see (e.g. "I expected to see the list of posts.")
Want to contribute a new feature? Please first [open a new issue](https://github.com/runcommand/sparks/issues/new) to discuss whether the feature is a good fit for the project. Once you've decided to work on a pull request, please include [functional tests](https://wp-cli.org/docs/pull-requests/#functional-tests) and follow the [WordPress Coding Standards](http://make.wordpress.org/core/handbook/coding-standards/).
Include as much detail as you can, and clear steps to reproduce if possible.
Don't have access to Sparks, or need to keep the discussion private? You can also email [support@runcommand.io](mailto:support@runcommand.io) with general questions, bug reports, and feature suggestions.
### Creating a pull request
Want to contribute a new feature? Please first [open a new issue](https://github.com/wp-cli/profile/issues/new) to discuss whether the feature is a good fit for the project.
Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience:
1. Create a feature branch for each contribution.
2. Submit your pull request early for feedback.
3. Include functional tests with your changes. [Read the WP-CLI documentation](https://wp-cli.org/docs/pull-requests/#functional-tests) for an introduction.
4. Follow the [WordPress Coding Standards](http://make.wordpress.org/core/handbook/coding-standards/).
*This README.md is generated dynamically from the project's codebase using `wp scaffold package-readme` ([doc](https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme)). To suggest changes, please submit a pull request against the corresponding part of the codebase.*

23
circle.yml
View file

@ -1,23 +0,0 @@
machine:
php:
version: 5.6.22
environment:
WP_CLI_BIN_DIR: /tmp/wp-cli-phar
dependencies:
cache_directories:
- ~/.composer/cache
pre:
# Set the PHP timezone so that Behat does not fail.
- echo "date.timezone = 'US/Central'" > /opt/circleci/php/$(phpenv global)/etc/conf.d/wp-cli-timezone.ini
# Disable xdebug, which makes Composer slower.
- echo "" > /opt/circleci/php/$(phpenv global)/etc/conf.d/xdebug.ini
test:
pre:
- composer validate
- bash bin/install-package-tests.sh
override:
- WP_VERSION=latest ./vendor/bin/behat --strict
- rm -rf '/tmp/wp-cli-test core-download-cache'
- WP_VERSION=trunk ./vendor/bin/behat --strict

18
composer.json
View file

@ -1,5 +1,5 @@
{
"name": "runcommand/profile",
"name": "wp-cli/profile",
"description": "Quickly identify what's slow with WordPress.",
"type": "wp-cli-package",
"homepage": "https://runcommand.io/wp/profile/",
@ -21,27 +21,15 @@
"profile eval-file"
],
"readme": {
"shields": [
"[![runcommand premium](https://runcommand.io/wp-content/themes/runcommand-theme/bin/shields/runcommand-premium.svg)](https://runcommand.io/pricing/)",
"[![version 0.3.0](https://runcommand.io/wp-content/themes/runcommand-theme/bin/shields/version-0-3-0.svg)](https://runcommand.io/2016/11/03/wp-profile-v0-3-0/)",
"[![CircleCI](https://circleci.com/gh/runcommand/profile/tree/master.svg?style=svg&circle-token=d916e588bf7c8ac469a3bd01930cf9eed886debe)](https://circleci.com/gh/runcommand/profile/tree/master)"
],
"sections": [
"Overview",
"Using",
"Installing",
"Support"
"Contributing"
],
"overview": {
"post": "bin/readme/overview-body.md"
},
"installing": {
"body": "bin/readme/installing-body.md"
},
"support": {
"body": "https://raw.githubusercontent.com/runcommand/runcommand-theme/master/bin/readme-partials/support-premium.md"
},
"show_powered_by": false
}
}
}
}