Merge branch 'release/0.1.0' into develop

CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+All notable changes to this project will be documented in this file, per [the Keep a Changelog standard](http://keepachangelog.com/), and this project will adhere to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [0.1.0] - 2023-09-13
+
+Initial public release. 🎉
+
+### Added
+
+- `tsconfig.json` file for code completion support (props [@dinhtungdu](https://github.com/dinhtungdu) via [#2](https://github.com/10up/cypress-wp-setup/pull/2)).
+- Add all standard workflow and informational files (props [@cadic](https://github.com/cadic), [@jeffpaul](https://github.com/jeffpaul) via [#1](https://github.com/10up/cypress-wp-setup/pull/1), [#6](https://github.com/10up/cypress-wp-setup/pull/6), [#7](https://github.com/10up/cypress-wp-setup/pull/7), [#10](https://github.com/10up/cypress-wp-setup/pull/10), [#12](https://github.com/10up/cypress-wp-setup/pull/12), [#13](https://github.com/10up/cypress-wp-setup/pull/13), [#16](https://github.com/10up/cypress-wp-setup/pull/16), [#18](https://github.com/10up/cypress-wp-setup/pull/18)).
+- Ability to specify just the WordPress version to run tests on, not the full `WordPress/WordPress#` syntax (props [@cadic](https://github.com/cadic) via [#9](https://github.com/10up/cypress-wp-setup/pull/9)).
+- Use the `@10up/cypress-wp-utils` library (props [@cadic](https://github.com/cadic), [@peterwilsoncc](https://github.com/peterwilsoncc), [@Sidsector9](https://github.com/Sidsector9) via [#11](https://github.com/10up/cypress-wp-setup/pull/11), [#15](https://github.com/10up/cypress-wp-setup/pull/15), [#31](https://github.com/10up/cypress-wp-setup/pull/31)).
+- Preserve cookies to keep a user logged in during tests (props [@cadic](https://github.com/cadic) via [#14](https://github.com/10up/cypress-wp-setup/pull/14)).
+- Set `chromeWebSecurity` to `false` in our Cypress config (props [@dkotter](https://github.com/dkotter), [@iamdharmesh](https://github.com/iamdharmesh) via [#34](https://github.com/10up/cypress-wp-setup/pull/34)).
+- New command, `env:destroy` that is used to destroy an environment (props [@dkotter](https://github.com/dkotter), [@Sidsector9](https://github.com/Sidsector9) via [#35](https://github.com/10up/cypress-wp-setup/pull/35)).
+
+### Changed
+
+- Run `npm install` script as a child process (props [@cadic](https://github.com/cadic), [@iamdharmesh](https://github.com/iamdharmesh) via [#19](https://github.com/10up/cypress-wp-setup/pull/19)).
+- Update minimum WordPress version from 4.9 to 5.7 (props [@iamdharmesh](https://github.com/iamdharmesh), [@cadic](https://github.com/cadic), [@Sidsector9](https://github.com/Sidsector9) via [#20](https://github.com/10up/cypress-wp-setup/pull/20), [#28](https://github.com/10up/cypress-wp-setup/pull/28)).
+- Migrated from Cypress 9 to Cypress 13 (props [@iamdharmesh](https://github.com/iamdharmesh), [@cadic](https://github.com/cadic), [@ravinderk](https://github.com/ravinderk) via [#23](https://github.com/10up/cypress-wp-setup/pull/23), [#37](https://github.com/10up/cypress-wp-setup/pull/37)).
+
+### Fixed
+
+- Remove existing `.wp-env.override.json` file if running tests on the `latest` WordPress version (props [@cadic](https://github.com/cadic) via [#8](https://github.com/10up/cypress-wp-setup/pull/8)).
+- Addressed a test failure due to invalid `config.baseUrl` (props [@iamdharmesh](https://github.com/iamdharmesh), [@peterwilsoncc](https://github.com/peterwilsoncc) via [#30](https://github.com/10up/cypress-wp-setup/pull/30)).
+- Addressed a few issues with the latest version of `wp-env` (props [@dkotter](https://github.com/dkotter), [@Sidsector9](https://github.com/Sidsector9) via [#35](https://github.com/10up/cypress-wp-setup/pull/35)).
+
+### Security
+
+- Upgrade `ansi-regex` from 2.1.1 to 6.0.1 (props [@cadic](https://github.com/cadic) via [#17](https://github.com/10up/cypress-wp-setup/pull/17)).
+- Upgrade `fs-extra` from 10.1.0 to 11.1.0 (props [@cadic](https://github.com/cadic), [@iamdharmesh](https://github.com/iamdharmesh) via [#32](https://github.com/10up/cypress-wp-setup/pull/32)).
+
+[Unreleased]: https://github.com/10up/cypress-wp-setup/compare/trunk...develop
+[0.1.0]: https://github.com/10up/cypress-wp-setup/releases/tag/0.1.0

CONTRIBUTING.md

@@ -24,4 +24,25 @@ For more on how 10up writes and manages code, check out our [10up Engineering Be
 
 ## Workflow
 
-The `develop` branch is the development branch which means it contains the next version to be released.  `trunk` contains the latest released version as reflected in the WordPress.org plugin repository.  Always work on the `develop` branch and open up PRs against `develop`.
+The `develop` branch is the development branch which means it contains the next version to be released.  `trunk` contains the latest released version.  Always work on the `develop` branch and open up PRs against `develop`.
+
+## Release instructions
+
+1. Branch: Starting from `develop`, cut a release branch named `release/X.Y.Z` for your changes.
+1. Version bump: Bump the version number in `package.json` and `package-lock.json` if it does not already reflect the version being released.
+1. Changelog: Add/update the changelog in `CHANGELOG.md`.
+1. Props: update `CREDITS.md` file with any new contributors, confirm maintainers are accurate.
+1. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in `.gitattributes`.
+1. Readme updates: Make any other readme changes as necessary.
+1. Merge: Make a non-fast-forward merge from your release branch to `develop` (or merge the pull request), then do the same for `develop` into `trunk`, ensuring you pull the most recent changes into `develop` first (`git checkout develop && git pull origin develop && git checkout trunk && git pull origin trunk && git merge --no-ff develop`). `trunk` contains the stable development version.
+1. Push: Push your trunk branch to GitHub (e.g. `git push origin trunk`).
+1. [Compare](https://github.com/10up/cypress-wp-setup/compare/trunk...develop) `trunk` to `develop` to ensure no additional changes were missed.
+1. Release: Create a [new release](https://github.com/10up/cypress-wp-setup/releases/new), naming the tag and the release with the new version number, and targeting the `trunk` branch.  Paste the changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues on the [milestone](https://github.com/10up/cypress-wp-setup/milestone/#?closed=1).
+1. Close milestone: Edit the [milestone](https://github.com/10up/cypress-wp-setup/milestone/#) with release date (in the `Due date (optional)` field) and link to GitHub release (in the `Description` field), then close the milestone.
+1. Punt incomplete items: If any open issues or PRs which were milestoned for `X.Y.Z` do not make it into the release, update their milestone to `X.Y.Z+1`, `X.Y+1.0`, `X+1.0.0` or `Future Release`.
+
+### What to do if things go wrong
+
+If you run into issues during the release process and things have NOT fully deployed to npm / whatever external-to-GitHub location that we might be publishing to, then the best thing to do will be to delete any Tag (e.g., <https://github.com/10up/cypress-wp-setup/releases/tag/TAGNAME>) or Release that's been created, research what's wrong, and once things are resolved work on re-tagging and re-releasing on GitHub and publishing externally where needed.
+
+If you run into issues during the release process and things HAVE deployed to npm / whatever external-to-GitHub location that we might be publishing to, then the best thing to do will be to research what's wrong and once things are resolved work on a patch release and tag on GitHub and publishing externally where needed.  At the top of the changelog / release notes it's best to note that its a hotfix to resolve whatever issues were found after the previous release.

CREDITS.md

@@ -12,7 +12,7 @@ The following individuals are responsible for curating the list of issues, respo
 
 Thank you to all the people who have already contributed to this repository via bug reports, code, design, ideas, project management, translation, testing, etc.
 
-[Max Lyuchin (@cadic)](https://github.com/cadic), [Tung Du (@dinhtungdu)](https://github.com/dinhtungdu), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul).
+[Max Lyuchin (@cadic)](https://github.com/cadic), [Tung Du (@dinhtungdu)](https://github.com/dinhtungdu), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [Peter Wilson (@peterwilsoncc)](https://github.com/peterwilsoncc), [Siddharth Thevaril (@Sidsector9)](https://github.com/Sidsector9), [Darin Kotter (@dkotter)](https://github.com/dkotter), [Dharmesh Patel (@iamdharmesh)](https://github.com/iamdharmesh), [Ravinder Kumar (@ravinderk)](https://github.com/ravinderk).
 
 ## Libraries
 

README.md

@@ -44,6 +44,7 @@ npm run env
 ```
 
 `<version>` might be:
+
 - `latest` to use current WordPress release
 - `master` to use nightly build
 - `5.9` to specify a version
@@ -72,8 +73,8 @@ cy.login();
 cy.activatePlugin("my-plugin");
 
 cy.createPost({
-	title: "Post Title",
-	content: 'Test Content',
+  title: "Post Title",
+  content: 'Test Content',
 });
 ```