This commit is contained in:
Jeff Stieler 2020-06-17 13:39:41 -04:00 committed by GitHub
parent 6e85cf977a
commit dd54268ad7
21 changed files with 29 additions and 33 deletions

View File

@ -48,8 +48,7 @@ script:
branches:
only:
- master
- version/1.0
- main
before_deploy:
# Remove our unneeded symlink.
@ -66,6 +65,6 @@ deploy:
keep_history: true
on:
condition: $RUN_JS == 1 # only deploy on the PHP 7.2/JS build
branch: master
branch: main
target_branch: gh-pages
verbose: true

View File

@ -70,7 +70,7 @@ After you've made your updates, you're ready to commit:
## Helper Scripts
There are a number of helper scripts exposed via our `package.json` (below list is not exhaustive, you can view the [`package.json` file directly to see all](https://github.com/woocommerce/woocommerce-admin/blob/master/package.json)):
There are a number of helper scripts exposed via our `package.json` (below list is not exhaustive, you can view the [`package.json` file directly to see all](https://github.com/woocommerce/woocommerce-admin/blob/main/package.json)):
- `npm run lint` : Run eslint over the javascript files
- `npm run i18n` : A multi-step process, used to create a pot file from both the JS and PHP gettext calls. First it runs `i18n:js`, which creates a temporary `.pot` file from the JS files. Next it runs `i18n:php`, which converts that `.pot` file to a PHP file. Lastly, it runs `i18n:pot`, which creates the final `.pot` file from all the PHP files in the plugin (including the generated one with the JS strings).

View File

@ -9,8 +9,8 @@ console.log( '\nBy contributing to this project, you license the materials you c
const currentBranch = execSync( 'git rev-parse --abbrev-ref HEAD' ).toString().trim();
if ( 'master' === currentBranch ) {
if ( ! readline.keyInYN( "You're about to push !!![ master ]!!!, is that what you intended?" ) ) {
if ( 'main' === currentBranch ) {
if ( ! readline.keyInYN( "You're about to push !!![ main ]!!!, is that what you intended?" ) ) {
process.exit( 1 );
}
}

View File

@ -1,7 +1,7 @@
Data
====
WooCommerce Admin data stores implement the [`SqlQuery` class](https://github.com/woocommerce/woocommerce-admin/blob/master/src/API/Reports/SqlQuery.php).
WooCommerce Admin data stores implement the [`SqlQuery` class](https://github.com/woocommerce/woocommerce-admin/blob/main/src/API/Reports/SqlQuery.php).
### SqlQuery Class

View File

@ -6,13 +6,13 @@ We rely on a markdown documentation file for [the docs site on github.io,](https
Use `npm run docs` to generate a `README.md` for your new component. This will create a basic documentation file containing the component name, description comment, component props, and a placeholder section for example usage.
Edit the documentation file for completeness. We recommend using a simple component as a reference (like the [Card component](https://raw.githubusercontent.com/woocommerce/woocommerce-admin/master/packages/components/src/card/README.md)).
Edit the documentation file for completeness. We recommend using a simple component as a reference (like the [Card component](https://raw.githubusercontent.com/woocommerce/woocommerce-admin/main/packages/components/src/card/README.md)).
## 2. Create a JavaScript example file
The JavaScript example will be rendered in the DevDocs section and serves as interactive documentation for the component. Create a `docs/example.js` file in the component directory.
See [count/docs/example.js](https://github.com/woocommerce/woocommerce-admin/blob/master/packages/components/src/count/docs/example.js) for a simple example, or [table/docs/example.js](https://github.com/woocommerce/woocommerce-admin/blob/master/packages/components/src/table/docs/example.js) for a more detailed example.
See [count/docs/example.js](https://github.com/woocommerce/woocommerce-admin/blob/main/packages/components/src/count/docs/example.js) for a simple example, or [table/docs/example.js](https://github.com/woocommerce/woocommerce-admin/blob/main/packages/components/src/table/docs/example.js) for a more detailed example.
## 3. Preview the documentation site

View File

@ -120,7 +120,7 @@ class WooCommerce_Activity_Panel_Inbox_Example_Plugin_One {
$note->add_action(
'settings',
__( 'Learn More', 'wapi-example-plugin-one' ),
'https://github.com/woocommerce/woocommerce-admin/tree/master/docs'
'https://github.com/woocommerce/woocommerce-admin/tree/main/docs'
);
$note->save();
}
@ -243,4 +243,4 @@ A limited set of note fields can be updated over the REST API: `status` and `dat
## Questions?
This is just the tip of the iceberg for possibilities for your own extensions to WooCommerce. Check
out the new [sales record notes](https://github.com/woocommerce/woocommerce-admin/blob/master/includes/notes/class-wc-admin-notes-new-sales-record.php) and the [settings notes](https://github.com/woocommerce/woocommerce-admin/blob/master/includes/notes/class-wc-admin-notes-settings-notes.php) in the woocommerce-admin code itself for other examples of working with this fun new feature.
out the new [sales record notes](https://github.com/woocommerce/woocommerce-admin/blob/main/includes/notes/class-wc-admin-notes-new-sales-record.php) and the [settings notes](https://github.com/woocommerce/woocommerce-admin/blob/main/includes/notes/class-wc-admin-notes-settings-notes.php) in the woocommerce-admin code itself for other examples of working with this fun new feature.

View File

@ -2,9 +2,6 @@
The onboarding feature is a reimagined new user setup experience for WooCommerce core. It contains two sections aimed at getting merchants started with their stores. The merchant begins with the "profile wizard", which helps with initial steps like setting a store address, making extension recommendations, and connecting to Jetpack for additional features. Once the profile wizard is complete, the merchant can purchase & install optional extensions via WooCommerce.com, before continuing to the "task list". From the task list, merchants are walked through a variety of items to help them start selling, such as adding their first product and setting up payment methods.
* Master Thread: p6q8Tx-R1-p2
* Designs: 2317a-pb
## Enabling Onboarding
If you run the development version of WooCommerce Admin from GitHub directly, no further action should be needed to enable Onboarding.
@ -122,9 +119,9 @@ If you are running the development version of WooCommerce Admin, and have [`WP_D
The `onboarding` feature flag is enabled in the main WooCommerce Admin plugin build. That means the published version of the plugin on WordPress.org contains the onboarding feature, but it is visually off by default. See the "enable onboarding" section above.
Sometimes, it may be necessary to generate a separate build of the plugin between public releases for internal testing or debugging. This can be done using the [building custom plugin builds](https://github.com/woocommerce/woocommerce-admin/blob/master/docs/feature-flags.md#building-custom-plugin-builds) feature of our build system.
Sometimes, it may be necessary to generate a separate build of the plugin between public releases for internal testing or debugging. This can be done using the [building custom plugin builds](https://github.com/woocommerce/woocommerce-admin/blob/main/docs/feature-flags.md#building-custom-plugin-builds) feature of our build system.
* Switch to the latest master branch and pull down any changes
* Switch to the latest `main` branch and pull down any changes
* Run `npm run build:release -- --slug onboarding --features '{"onboarding":true}'`
* A special `woocommerce-admin-onboarding.zip` release will be generated, containing the latest onboarding code
* Make sure to follow the directions in the "enabling onboarding" section above to properly use the build

View File

@ -2,7 +2,7 @@
The Orders Report provides insight about your store's orders.
By default, orders with non-excluded statuses are listed by order date descending. Excluded statuses can be edited on the [Settings page](https://github.com/woocommerce/woocommerce-admin/blob/master/docs/woocommerce.com/analytics-settings.md#excluded-statuses)
By default, orders with non-excluded statuses are listed by order date descending. Excluded statuses can be edited on the [Settings page](https://github.com/woocommerce/woocommerce-admin/blob/main/docs/woocommerce.com/analytics-settings.md#excluded-statuses)
Refunded orders cannot be excluded from the orders report. Refunded orders have two rows in the report: one for the date of the original order and one for the date of refund.

View File

@ -1,11 +1,11 @@
# Languages
## Contributing a Translation
If you'd like to contribute a translation, please follow the Localizing section in [CONTRIBUTING.md](https://github.com/woocommerce/woocommerce-admin/blob/master/CONTRIBUTING.md).
If you'd like to contribute a translation, please follow the Localizing section in [CONTRIBUTING.md](https://github.com/woocommerce/woocommerce-admin/blob/main/CONTRIBUTING.md).
## Generating POT
The generated POT template file is not included in this repository. To create this file locally, follow instructions from [README.md](https://github.com/woocommerce/woocommerce-admin/blob/master/README.md) to install the project, then run the following command:
The generated POT template file is not included in this repository. To create this file locally, follow instructions from [README.md](https://github.com/woocommerce/woocommerce-admin/blob/main/README.md) to install the project, then run the following command:
```
npm run i18n lang=xx_YY

View File

@ -38,7 +38,7 @@ To create a new package, add a new folder to `/packages`, containing…
"wordpress",
"woocommerce"
],
"homepage": "https://github.com/woocommerce/woocommerce-admin/tree/master/packages/[_YOUR_PACKAGE_]/README.md",
"homepage": "https://github.com/woocommerce/woocommerce-admin/tree/main/packages/[_YOUR_PACKAGE_]/README.md",
"repository": {
"type": "git",
"url": "https://github.com/woocommerce/woocommerce-admin.git"

View File

@ -9,7 +9,7 @@
"woocommerce",
"components"
],
"homepage": "https://github.com/woocommerce/woocommerce-admin/tree/master/packages/components/README.md",
"homepage": "https://github.com/woocommerce/woocommerce-admin/tree/main/packages/components/README.md",
"repository": {
"type": "git",
"url": "https://github.com/woocommerce/woocommerce-admin.git"

View File

@ -121,7 +121,7 @@ const config = {
};
```
`type`: A string Autocompleter type used by the [Search Component](https://github.com/woocommerce/woocommerce-admin/tree/master/packages/components/src/search).
`type`: A string Autocompleter type used by the [Search Component](https://github.com/woocommerce/woocommerce-admin/tree/main/packages/components/src/search).
`getLabels`: A function returning a Promise resolving to an array of objects with `id` and `label` properties.

View File

@ -9,7 +9,7 @@
"woocommerce",
"csv"
],
"homepage": "https://github.com/woocommerce/woocommerce-admin/tree/master/packages/csv-export/README.md",
"homepage": "https://github.com/woocommerce/woocommerce-admin/tree/main/packages/csv-export/README.md",
"repository": {
"type": "git",
"url": "https://github.com/woocommerce/woocommerce-admin.git"

View File

@ -9,7 +9,7 @@
"woocommerce",
"currency"
],
"homepage": "https://github.com/woocommerce/woocommerce-admin/tree/master/packages/currency/README.md",
"homepage": "https://github.com/woocommerce/woocommerce-admin/tree/main/packages/currency/README.md",
"repository": {
"type": "git",
"url": "https://github.com/woocommerce/woocommerce-admin.git"

View File

@ -9,7 +9,7 @@
"woocommerce",
"data"
],
"homepage": "https://github.com/woocommerce/woocommerce-admin/tree/master/packages/data/README.md",
"homepage": "https://github.com/woocommerce/woocommerce-admin/tree/main/packages/data/README.md",
"repository": {
"type": "git",
"url": "https://github.com/woocommerce/woocommerce-admin.git"

View File

@ -9,7 +9,7 @@
"woocommerce",
"date"
],
"homepage": "https://github.com/woocommerce/woocommerce-admin/tree/master/packages/date/README.md",
"homepage": "https://github.com/woocommerce/woocommerce-admin/tree/main/packages/date/README.md",
"repository": {
"type": "git",
"url": "https://github.com/woocommerce/woocommerce-admin.git"

View File

@ -9,7 +9,7 @@
"woocommerce",
"navigation"
],
"homepage": "https://github.com/woocommerce/woocommerce-admin/tree/master/packages/navigation/README.md",
"homepage": "https://github.com/woocommerce/woocommerce-admin/tree/main/packages/navigation/README.md",
"repository": {
"type": "git",
"url": "https://github.com/woocommerce/woocommerce-admin.git"

View File

@ -8,7 +8,7 @@
"wordpress",
"woocommerce"
],
"homepage": "https://github.com/woocommerce/woocommerce-admin/tree/master/packages/number/README.md",
"homepage": "https://github.com/woocommerce/woocommerce-admin/tree/main/packages/number/README.md",
"repository": {
"type": "git",
"url": "https://github.com/woocommerce/woocommerce-admin.git"

View File

@ -6,7 +6,7 @@ Tested up to: 5.4.1
Requires PHP: 5.6.20
Stable tag: 1.3.0-beta.1
License: GPLv3
License URI: https://github.com/woocommerce/woocommerce-admin/blob/master/license.txt
License URI: https://github.com/woocommerce/woocommerce-admin/blob/main/license.txt
== Description ==
@ -412,7 +412,7 @@ Release and roadmap notes are available on the [WooCommerce Developers Blog](htt
- Fix: Retrieve week last year data by calendar date instead of week alignment. #3271 (Analytics, Packages)
- Bug: Check if extended_info is set for order report items #3315 (REST API)
- Tweak: remove global settings dependency from Navigation package. #3294 (Components, Packages)
- Fix: Fix checkout of master branch in CI environment. #3296 (Build)
- Fix: Fix checkout of main branch in CI environment. #3296 (Build)
- Fix: decouple Date package from global wcSettings object. #3278 (Components, Packages)
- Fix: Make the order count between customer and table total consistent. #3290 (Analytics)
- Fix: decouple Currency and Number packages from global wcSettings object. #3277 (Components, Packages)
@ -484,7 +484,7 @@ Release and roadmap notes are available on the [WooCommerce Developers Blog](htt
- Dev: Add GitHub pages deploy step to Travis config. #2940 (Build, Documentation)
- Dev: Fix plugin installation when working from a push instead of a pull request. #2950 (Build)
- Dev: Fix pull request branch detection on CI (try #2) #2944 (Build)
- Dev: Only build pushes to master branch. #2941 (Build)
- Dev: Only build pushes to main branch. #2941 (Build)
- Performance: reduce JS bundle size. #2933 (Build)
- Dev: Fix pull request branch detection on CI #2942 (Build)
- Dev: refresh component documentation #2872 (Build, Components, Documentation, Packages)

View File

@ -691,7 +691,7 @@ class Onboarding {
* @param array $plugins Array of plugin slugs to be allowed.
*
* @return array
* @todo Handle edgecase of where installed plugins may have versioned folder names (i.e. `jetpack-master/jetpack.php`).
* @todo Handle edgecase of where installed plugins may have versioned folder names (i.e. `jetpack-main/jetpack.php`).
*/
public static function get_onboarding_allowed_plugins( $plugins ) {
$onboarding_plugins = apply_filters(

View File

@ -72,7 +72,7 @@ class DataSourcePoller {
* Merge the specs.
*
* @param Array $specs_to_merge_in The specs to merge in to $specs.
* @param Array $specs The master list of specs.
* @param Array $specs The list of specs being merged into.
*/
private static function merge_specs( $specs_to_merge_in, &$specs ) {
foreach ( $specs_to_merge_in as $spec ) {