Skip to content

Commit

Permalink
Merge branch 'develop' into trunk
Browse files Browse the repository at this point in the history
  • Loading branch information
Sidsector9 committed Apr 18, 2023
2 parents 61703f8 + ab63f83 commit d2df596
Show file tree
Hide file tree
Showing 23 changed files with 37,321 additions and 34,980 deletions.
2 changes: 1 addition & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ module.exports = {
},
},

ignorePatterns: [ '*.min.js' ],
ignorePatterns: [ '*.min.js', 'tests/*' ],
};
38 changes: 38 additions & 0 deletions .github/workflows/cypress.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: E2E test

on:
push:
branches:
- develop
- trunk
pull_request:
branches:
- develop
jobs:
cypress:
name: ${{ matrix.core.name }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
core:
- {name: 'WP latest', version: 'latest'}
- {name: 'WP minimum', version: 'WordPress/WordPress#6.1'}
- {name: 'WP trunk', version: 'WordPress/WordPress#master'}
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Install dependencies
run: npm install
- name: Composer (optional)
run: composer install
continue-on-error: true
- name: Build (optional)
run: npm run build
continue-on-error: true
- name: Set the core version
run: ./tests/bin/set-core-version.js ${{ matrix.core.version }}
- name: Set up WP environment
run: npm run env:start
- name: Test
run: npm run cypress:run
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,5 @@ Desktop.ini

##
*.p8
.env
.env
.wp-env.override.json
Binary file added .wordpress-org/screenshot-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .wordpress-org/screenshot-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,21 @@ All notable changes to this project will be documented in this file, per [the Ke

## [Unreleased] - TBD

## [1.3.0] - 2023-04-18

### Added
- E2E tests using Cypress (props [@vikrampm1](https://github.com/vikrampm1), [@barneyjeffries](https://github.com/barneyjeffries), [@iamdharmesh](https://github.com/iamdharmesh), [@cadic](https://github.com/cadic)) via [#87](https://github.com/10up/retro-winamp-block/pull/87).

### Changed
- Bump WordPress "tested up to" version from 6.1 to 6.2 (props [@jayedul](https://github.com/jayedul), [@peterwilsoncc](https://github.com/peterwilsoncc)) via [#92](https://github.com/10up/retro-winamp-block/pull/92)
- [Support Level](https://github.com/10up/retro-winamp-block#support-level) from `Active` to `Stable` (props [@jeffpaul](https://github.com/jeffpaul), [@Sidsector9](https://github.com/Sidsector9)) via [#94](https://github.com/10up/retro-winamp-block/pull/94).

### Security
- Bump `simple-git` from `3.15.1` to `3.16.0` (props [@Sidsector9](https://github.com/Sidsector9)) via [#82](https://github.com/10up/retro-winamp-block/pull/82).
- Bump `http-cache-semantics` from `4.1.0` to `4.1.1` (props [@peterwilsoncc](https://github.com/peterwilsoncc)) via [#85](https://github.com/10up/retro-winamp-block/pull/85).
- Bump `@sideway/formula` from `3.0.0` to `3.0.1` (props [@faisal-alvi](https://github.com/faisal-alvi)) via [#86](https://github.com/10up/retro-winamp-block/pull/86).
- Bump `webpack` from `5.73.0` to `5.76.2` (props [@faisal-alvi](https://github.com/faisal-alvi)) via [#90](https://github.com/10up/retro-winamp-block/pull/90).

## [1.2.0] - 2023-01-30
**Note that this release changes the minimum PHP version to from 5.6 to 7.4.**

Expand Down Expand Up @@ -65,6 +80,7 @@ All notable changes to this project will be documented in this file, per [the Ke
- Initial release of the Winamp Block plugin. 🎉

[Unreleased]: https://github.com/10up/retro-winamp-block/compare/trunk...develop
[1.3.0]: https://github.com/10up/retro-winamp-block/compare/1.2.0...1.3.0
[1.2.0]: https://github.com/10up/retro-winamp-block/compare/1.1.0...1.2.0
[1.1.0]: https://github.com/10up/retro-winamp-block/compare/1.0.1...1.1.0
[1.0.1]: https://github.com/10up/retro-winamp-block/compare/1.0.0...1.0.1
Expand Down
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ The `develop` branch is the development branch which means it contains the next
4. Props: update `CREDITS.md` with any new contributors, confirm maintainers are accurate.
5. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in `.distignore`.
6. Readme updates: Make any other readme changes as necessary. `README.md` is geared toward GitHub and `readme.txt` contains WordPress.org-specific content. The two are slightly different.
7. 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` (`git checkout trunk && git merge --no-ff develop`). `trunk` contains the stable development version.
Test: Run through common tasks while on `trunk` to be sure it functions correctly. Don't forget to build.
7. 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 merge --no-ff develop`). `trunk` contains the stable development version.
8. Push: Push your `trunk` branch to GitHub (e.g. `git push origin trunk`).
9. Test the pre-release ZIP locally by downloading it from the **Build release zip** action artifact to ensure the plugin doesn't break after release.
10. Release: Create a [new release](https://github.com/10up/retro-winamp-block/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/retro-winamp-block/milestone/#?closed=1).
11. SVN: Wait for the [GitHub Action](https://github.com/10up/retro-winamp-block/actions/workflows/wordpress-plugin-deploy.yml) to finish deploying to the WordPress.org repository. If all goes well, users with SVN commit access for that plugin will receive an emailed diff of changes.
12. Check WordPress.org: Ensure that the changes are live on https://wordpress.org/plugins/retro-winamp-block/. This may take a few minutes.
13. Close the milestone: Edit the [X.Y.Z milestone](https://github.com/10up/retro-winamp-block/milestone/#) with release date (in the `Due date (optional)` field) and link to GitHub release (in the `Description` field), then close the milestone.
14. 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+1.0.0`, `X.Y+1.0`, `X.Y.Z+1`, or `Future Release`
9. [Compare](https://github.com/10up/retro-winamp-block/compare/trunk...develop) `trunk` to `develop` to ensure no additional changes were missed.
10. Test the pre-release ZIP locally by [downloading](https://github.com/10up/retro-winamp-block/actions/workflows/build-release-zip.yml) it from the Build release zip action artifact and installing it locally. Ensure this zip has all the files we expect, that it installs and activates correctly and that all basic functionality is working.
11. Release: Create a [new release](https://github.com/10up/retro-winamp-block/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/retro-winamp-block/milestone/#?closed=1).
12. SVN: Wait for the [GitHub Action](https://github.com/10up/retro-winamp-block/actions/workflows/wordpress-plugin-deploy.yml) to finish deploying to the WordPress.org repository. If all goes well, users with SVN commit access for that plugin will receive an emailed diff of changes.
13. Check WordPress.org: Ensure that the changes are live on [WordPress.org](https://wordpress.org/plugins/retro-winamp-block/). This may take a few minutes.
14. Close the milestone: Edit the [X.Y.Z milestone](https://github.com/10up/retro-winamp-block/milestone/#) with release date (in the `Due date (optional)` field) and link to GitHub release (in the `Description` field), then close the milestone.
15. 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+1.0.0`, `X.Y+1.0`, `X.Y.Z+1`, or `Future Release`.
2 changes: 1 addition & 1 deletion CREDITS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

[Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [Tung Du (@dinhtungdu)](https://github.com/dinhtungdu), [Fabian Kägy (@fabiankaegy)](https://github.com/fabiankaegy), [Darin Kotter (@dkotter)](https://github.com/dkotter), [Mel Choyce-Dwan (@melchoyce)](https://github.com/melchoyce), [Crisoforo Gaspar Hernández (@mitogh)](https://github.com/mitogh), [Helen Hou-Sandi (@helen)](https://github.com/helen), [Sudip Dadhaniya (@sudip-10up)](https://github.com/sudip-10up), [Dharmesh Patel (@iamdharmesh)](https://github.com/iamdharmesh), [Peter Wilson (@peterwilsoncc)](https://github.com/peterwilsoncc), [Faisal Alvi (@faisal-alvi)](https://github.com/faisal-alvi), [Siddharth Thevaril (@Sidsector9)](https://github.com/Sidsector9), [Vikram Moparthy (@vikrampm1)](https://github.com/vikrampm1), [Peter Wilson (@peterwilsoncc)](https://github.com/peterwilsoncc), [Quamruz Zaman (@zamanq)](https://github.com/zamanq), [Ian Svoboda (@iansvo)](https://github.com/iansvo), [Ajay Maurya (@ajmaurya99)](https://github.com/ajmaurya99), [Max Lyuchin (@cadic)](https://github.com/cadic), [Jayedul Kabir (@jayedul)](https://github.com/jayedul)).
[Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [Tung Du (@dinhtungdu)](https://github.com/dinhtungdu), [Fabian Kägy (@fabiankaegy)](https://github.com/fabiankaegy), [Darin Kotter (@dkotter)](https://github.com/dkotter), [Mel Choyce-Dwan (@melchoyce)](https://github.com/melchoyce), [Crisoforo Gaspar Hernández (@mitogh)](https://github.com/mitogh), [Helen Hou-Sandi (@helen)](https://github.com/helen), [Sudip Dadhaniya (@sudip-10up)](https://github.com/sudip-10up), [Dharmesh Patel (@iamdharmesh)](https://github.com/iamdharmesh), [Peter Wilson (@peterwilsoncc)](https://github.com/peterwilsoncc), [Faisal Alvi (@faisal-alvi)](https://github.com/faisal-alvi), [Siddharth Thevaril (@Sidsector9)](https://github.com/Sidsector9), [Vikram Moparthy (@vikrampm1)](https://github.com/vikrampm1), [Peter Wilson (@peterwilsoncc)](https://github.com/peterwilsoncc), [Quamruz Zaman (@zamanq)](https://github.com/zamanq), [Ian Svoboda (@iansvo)](https://github.com/iansvo), [Ajay Maurya (@ajmaurya99)](https://github.com/ajmaurya99), [Max Lyuchin (@cadic)](https://github.com/cadic), [Jayedul Kabir (@jayedul)](https://github.com/jayedul), [Barney Jeffries (@barneyjeffries)](https://github.com/barneyjeffries).

## Libraries

Expand Down
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

> A Winamp-styled audio block for all your retro music player needs.
[![Support Level](https://img.shields.io/badge/support-active-green.svg)](#support-level) [![Release Version](https://img.shields.io/github/release/10up/retro-winamp-block.svg)](https://github.com/10up/retro-winamp-block/releases/latest) ![WordPress tested up to version](https://img.shields.io/wordpress/plugin/tested/retro-winamp-block?label=WordPress) [![GPLv2 License](https://img.shields.io/github/license/10up/retro-winamp-block.svg)](https://github.com/10up/retro-winamp-block/blob/develop/LICENSE.md)
[![Support Level](https://img.shields.io/badge/support-stable-blue.svg)](#support-level) [![Release Version](https://img.shields.io/github/release/10up/retro-winamp-block.svg)](https://github.com/10up/retro-winamp-block/releases/latest) ![WordPress tested up to version](https://img.shields.io/wordpress/plugin/tested/retro-winamp-block?label=WordPress) [![GPLv2 License](https://img.shields.io/github/license/10up/retro-winamp-block.svg)](https://github.com/10up/retro-winamp-block/blob/develop/LICENSE.md)

[![E2E test](https://github.com/10up/retro-winamp-block/actions/workflows/cypress.yml/badge.svg)](https://github.com/10up/retro-winamp-block/actions/workflows/cypress.yml) [![JS and CSS lint](https://github.com/10up/retro-winamp-block/actions/workflows/eslint.yml/badge.svg)](https://github.com/10up/retro-winamp-block/actions/workflows/eslint.yml) [![PHPCS](https://github.com/10up/retro-winamp-block/actions/workflows/phpcs.yml/badge.svg)](https://github.com/10up/retro-winamp-block/actions/workflows/phpcs.yml) [![PHP Compatibility](https://github.com/10up/retro-winamp-block/actions/workflows/php-compatibility.yml/badge.svg)](https://github.com/10up/retro-winamp-block/actions/workflows/php-compatibility.yml)

## Overview

Expand All @@ -12,10 +14,12 @@ Do you miss the days of filling up your computer's harddrive with MP3 files, bur

![Winamp Block](.wordpress-org/screenshot-1.png "The Winamp player with the base, default skin.")

![Winamp Milkdrop visualisations](.wordpress-org/screenshot-3.png "The Winamp player with the Mildrop visualizer enabled.")

## Requirements

* PHP >=7.4
* [WordPress](http://wordpress.org/) >=5.8
* [WordPress](http://wordpress.org/) >=6.1

## Installation

Expand All @@ -25,7 +29,11 @@ Do you miss the days of filling up your computer's harddrive with MP3 files, bur

## Changing Player Skins

In order to select alternate player skins, browse [the Winamp Skin Museum](https://skins.webamp.org/) and find a preferred skin, copy the URL of the specific skin (e.g., https://skins.webamp.org/skin/bb0bf8064d108271afea419308dcb6ea/NES_Duck_Hunt.wsz/), and paste that URL in the `Skin URL` field in the Winamp Block Skin settings.
There are four default skins included in the plugin, these can be selected via the visual options in the "Winamp Player Skin" block sidebar option.

![Winamp player skin selector](.wordpress-org/screenshot-4.png "Winamp Block settings showing the default skin selections and toggle to enable custom Skin URL entry.")

In order to select alternate player skins, browse [the Winamp Skin Museum](https://skins.webamp.org/) and find a preferred skin, copy the URL of the specific skin (e.g., https://skins.webamp.org/skin/bb0bf8064d108271afea419308dcb6ea/NES_Duck_Hunt.wsz/), enable the "Use Custom Skin?" option, and paste the URL in the `Skin URL` field in the Winamp Block Skin settings.

![Winamp Block settings](.wordpress-org/screenshot-2.png "Winamp Block settings showing the Skin URL setting updated to an alternate Winamp skin.")

Expand All @@ -41,7 +49,7 @@ Details on how to create a new skin is available [here](https://github.com/WACUP

## Support Level

**Active:** 10up is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of WordPress. Bug reports, feature requests, questions, and pull requests are welcome.
**Stable:** 10up is not planning to develop any new features for this, but will still respond to bug reports and security concerns. We welcome PRs, but any that include new features should be small and easy to integrate and should not include breaking changes. We otherwise intend to keep this tested up to the most recent version of WordPress.

## Changelog

Expand Down
Loading

0 comments on commit d2df596

Please sign in to comment.