Skip to content

Commit

Permalink
Merge pull request #429 from Automattic/feature/2.0.0-changelog
Browse files Browse the repository at this point in the history
Docs: change log for 2.0.0
  • Loading branch information
GaryJones authored Jul 12, 2019
2 parents 2ce09b7 + 311cbfe commit a57c4f2
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 5 deletions.
48 changes: 48 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,53 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [2.0.0] - 2019-07-12

This release switches from having WPCS `1.*` as a dependency, to WPCS `2.*`. It is not compatible with WPCS `1.*`.

The sniffs in WPCS `2.*` are more accurate, so you may see new violations there weren't being reported before, and a reduction in violations for false positives.

## Added

- Switch to using WPCS `2.*`.
- Remove reference to WPCS's `PHPAliases.php`.
- Remove WPCS `1.*`'s `WordPress.VIP` references from rulesets.
- Bump PHPCS minimum required version to 3.3.1.
- Update the WPCS namespace.
- Update ruleset and ruleset test to account for WPCS 2's switch to `WordPress.PHP.IniSet` sniff.
- Update ruleset test for WPCS security sniffs.
- Update `DiscouragedPHPFunctions` group exclusion in `WordPressVIPMinimum` ruleset.

## Changed

- Downgrade use of file operation functions to Warning:
- `delete`
- `file_put_contents`
- `flock`
- `fputcsv`
- `fputs`
- `fwrite`
- `ftruncate`
- `is_writable`
- `is_writeable`
- `link`
- `rename`
- `symlink`
- `tempnam`
- `touch`
- `unlink`
- `fclose`
- `fopen`
- `file_get_contents`
- Simplify Travis config
- Switch references from `vip.wordpress.com` to `wpvip.com`.
- Documentation updates.
- Switch development to a `git-flow` workflow.

## Fixed

- Fixed CS violations in VIPCS code.

## [1.0.0] - 2019-04-24

This release contains many breaking changes.
Expand Down Expand Up @@ -320,4 +367,5 @@ This release contains breaking changes.
- `wpcom_vip_get_page_by_path` from `WordPressVIPMinimum.VIP.RestrictedFunctions`
- Version check for PHP 7 or less in `WordPressVIPMinimum.Variables.VariableAnalysis` unit test since tests are not failing anymore.

[2.0.0]: https://github.com/Automattic/VIP-Coding-Standards/compare/1.0.0...2.0.0
[1.0.0]: https://github.com/Automattic/VIP-Coding-Standards/compare/0.4.0...1.0.0
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,13 +99,13 @@ The easiest way to do this is to add a `phpunit.xml` file to the root of your VI

Expected output:
```
PHPUnit 7.2.6 by Sebastian Bergmann and contributors.
PHPUnit 7.5.12 by Sebastian Bergmann and contributors.

................................. 33 / 33 (100%)
........................................... 43 / 43 (100%)

Tests generated 29 unique error codes; 0 were fixable (0%)
44 sniff test files generated 119 unique error codes; 0 were fixable (0%)

Time: 268 ms, Memory: 30.00MB
Time: 380 ms, Memory: 30.00MB
```
### Unit Testing conventions
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This project contains two rulesets:

These rulesets contain only the rules which are considered to be "errors" and "warnings" according to the [WordPress VIP Go documentation](https://wpvip.com/documentation/vip-go/code-review-blockers-warnings-notices/)

The rulesets use rules from the [WordPress-Coding-Standards](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards) (WPCS) project.
The rulesets use rules from the [WordPress Coding Standards](https://github.com/WordPress/WordPress-Coding-Standards) (WPCS) project.

Go to https://wpvip.com/documentation/phpcs-review-feedback/ to learn about why violations are flagged as errors vs warnings and what the levels mean.

Expand Down

0 comments on commit a57c4f2

Please sign in to comment.