-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #39 from GeoJunkie/release/1.1
Release/1.1
- Loading branch information
Showing
5 changed files
with
59 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| README.md | ||
| .vscode | ||
| .github | ||
| .gitignore | ||
| .git |
35 changes: 35 additions & 0 deletions
35
...hub/workflows/deploy-on-publishing-a-new-release-and-attach-a-zip-file-to-the-release.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| name: Deploy to WordPress.org Repository | ||
| on: | ||
| release: | ||
| # run only when a new release is published, but not when it's classified as a pre-release. | ||
| types: [released] | ||
| jobs: | ||
| deploy_to_wp_repository: | ||
| name: Deploy to WP.org | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v2 | ||
| # We don't currently need to build the plugin. This will be added in v2. | ||
| # - name: Build | ||
| # run: | | ||
| # npm install | ||
| # npm run build | ||
| - name: WordPress Plugin Deploy | ||
| id: deploy | ||
| uses: 10up/action-wordpress-plugin-deploy@stable | ||
| with: | ||
| generate-zip: true | ||
| env: | ||
| SVN_USERNAME: ${{ secrets.SVN_USERNAME }} | ||
| SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }} | ||
| SLUG: wftda-rankings-widget | ||
| - name: Upload release asset | ||
| uses: actions/upload-release-asset@v1 | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| with: | ||
| upload_url: ${{ github.event.release.upload_url }} | ||
| asset_path: ${{ steps.deploy.outputs.zip-path }} | ||
| asset_name: ${{ github.event.repository.name }}.zip | ||
| asset_content_type: application/zip |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,62 +1,15 @@ | ||
| # WFTDA Rankings Widget | ||
| **Contributors:** mikestraw | ||
| **Tags:** roller derby, wftda, sports, rankings, stats | ||
| **Requires at least:** 3.0.1 | ||
| **Tested up to:** 5.8 | ||
| **Stable tag:** 1.0.1 | ||
| **License:** GPLv2 or later | ||
| **License URI:** http://www.gnu.org/licenses/gpl-2.0.html | ||
|
|
||
| A widget to show a WFTDA league’s ranking information in a widget. | ||
| ## Description | ||
| Add a widget to your site with the WFTDA stats from stats.wftda.com. | ||
|
|
||
| Currently, the widget will scrape the data from http://stats.wftda.com/league/{league}. Once the WFTDA makes an API available, it will use that API. | ||
| Currently, the widget will scrape the data from http://stats.wftda.com/team/{team}. Once the WFTDA makes an API available, it will use that API. | ||
|
|
||
| **This plugin was developed by a roller derby referee, fan, and league member. It isn’t approved of, endorsed, or part of the Women’s Flat Track Derby Association (WFTDA). I just made this to meet a need in my own league and wanted to share it.** | ||
| ## Getting the plugin | ||
|
|
||
| There are measures in place to ensure we don’t overload the stats site: | ||
| * We won’t use live stats unless and until the API has a good way to do that | ||
| * Rankings for each league will be stored locally when first retrieved and then refreshed only if the data is over 24 hours old | ||
| ## Future enhancements | ||
| * More configuration options for the widget: | ||
| * Choice of which stats to display | ||
| * Visual customizations | ||
| * Create a block | ||
| * Make available as a shortcode | ||
| * Add hooks for extendability | ||
| * Convert to API when available | ||
| ## Installation | ||
| 1. Install directly from WordPress.org, upload `wftda-rankings-widget.zip` under **Plugins > Add New**, or install via WP-CLI using `wp plugin install wftda-rankings-widget` | ||
| 2. Activate the plugin through the ‘Plugins’ menu in WordPress | ||
| 3. Add the widget in the Customizer | ||
| 4. The League Slug should match the portion of the address of your league’s stats after the last slash. e.g., if the address for your league’s stats page is `https://stats.wftda.com/league/super-fantastic-derby`, enter `super-fantastic-derby` under League Slug | ||
| ## Frequently Asked Questions | ||
| ### What if it doesn’t work? | ||
| * Make sure it’s installed properly | ||
| * Make sure your site can read external URLs | ||
| * Activate WP_DEBUG and check for any errors | ||
| * Ask on the support forums | ||
| ### Can I help make the plugin better? | ||
| * Absolutely! You can contribute [on GitHub](https://github.com/GeoJunkie/league-wftda-ranking) | ||
| ## Screenshots | ||
| ### 1. The widget as it appears on the page | ||
| The widget as it appears on the page | ||
| ### 2. Widget settings | ||
| Widget settings | ||
| ## Changelog | ||
| ### 1.0.2 - 2020-04-12 | ||
| * Readme updates | ||
| * Added an icon | ||
| ### 1.0.1 - 2020-04-05 | ||
| * Converted to HTTP API | ||
| * Updated league data storage to prevent refreshes on every page load | ||
| ### 1.0.0 - 2020-03-21 | ||
| * The initial release | ||
| ## Upgrade Notice | ||
| ### 1.0.2 | ||
| Update to WordPress.org information. Strictly cosmetic | ||
| ### 1.0.1 | ||
| Release to WordPress.org | ||
| ### 1.0.0 | ||
| Initial plugin release | ||
| The most current released version is [available on WordPress.org](https://wordpress.org/plugins/wftda-rankings-widget/). You can also install it directly from your WordPress dashboard. | ||
|
|
||
| It can also be downloaded [directly from this repository](https://github.com/GeoJunkie/league-wftda-ranking/releases/latest). | ||
|
|
||
| ## Contributing | ||
|
|
||
| I'm currently working to update the build process, which will also make this more available to contributors. This section will be updated once that process is complete. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters