diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..4d1e2d2 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,31 @@ +## How to contribute + +#### **Did you find a bug?** + +* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/runelaenen/sw6-category-links/issues). + +* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/runelaenen/sw6-category-links/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible. Images or screen-captures are very welcome. + +#### **Is this your first time contributing to an open source project on GitHub?** + +Great! And welcome to the team! + +It's not difficult, but there are some rules to adhere to: + +* Work on your own fork. Fork the repo and push your changes to this repo. Create PR when you're done. + +* Use feature branches. Don't work directly on the `master` branch, but create a different branch for every issue you tackle. For example `feature/issue-22` or `feature/fixes-nasty-bug-x` + +#### **Did you write an update that fixes a bug?** + +* Open a new GitHub pull request with the change. + +* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. + + + + + +This plugin is a volunteer effort. We encourage you to pitch in and join the team! + +Thanks! :blue_heart: :blue_heart: :blue_heart: diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..9a769aa --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +github: runelaenen +custom: "https://buymeacoffee.com/runelaenen" diff --git a/.github/workflows/create-zip.yml b/.github/workflows/create-zip.yml new file mode 100644 index 0000000..11a9f26 --- /dev/null +++ b/.github/workflows/create-zip.yml @@ -0,0 +1,50 @@ +name: Create zip +on: + push: + tags: + - '*' + +jobs: + CreateZip: + runs-on: ubuntu-latest + container: ghcr.io/friendsofshopware/platform-plugin-dev:v6.3.1 + steps: + - name: Get the version + id: get_version + run: echo ::set-output name=VERSION::${GITHUB_REF#refs/tags/} + + - name: Checkout + uses: actions/checkout@v2.3.1 + with: + path: RuneLaenenCategoryLinks + + - name: Build & create zip + run: | + cp -r "./RuneLaenenCategoryLinks" "/plugins/RuneLaenenCategoryLinks" + #composer install -d "/plugins/RuneLaenenCategoryLinks" --no-ansi --no-dev --no-interaction --no-plugins --no-progress --no-scripts --no-suggest --optimize-autoloader --ignore-platform-reqs + start-mysql + pack-plugin "RuneLaenenCategoryLinks" + + - name: Create Release + if: startsWith(github.ref, 'refs/tags/') + id: create_release + uses: actions/create-release@v1.0.0 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + tag_name: ${{ steps.get_version.outputs.VERSION }} + release_name: ${{ steps.get_version.outputs.VERSION }} + draft: false + prerelease: false + + - name: Upload Release Asset + if: startsWith(github.ref, 'refs/tags/') + id: upload_release_asset + uses: actions/upload-release-asset@v1.0.2 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + upload_url: ${{ steps.create_release.outputs.upload_url }} + asset_path: RuneLaenenCategoryLinks.zip + asset_name: RuneLaenenCategoryLinks.zip + asset_content_type: application/zip diff --git a/README.md b/README.md new file mode 100644 index 0000000..7bd31af --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# Category Links plugin for Shopware 6 + +[![Latest Stable Version](https://img.shields.io/github/v/release/runelaenen/sw6-category-links?color=lightblue&label=stable&logo=github)](//packagist.org/packages/runelaenen/sw6-category-links) +[![Download plugin zip](https://img.shields.io/github/v/release/runelaenen/sw6-category-links.svg?label=.zip%20download&logo=github)](https://github.com/runelaenen/sw6-category-links/releases/latest) +[![Total Downloads](https://img.shields.io/packagist/dt/runelaenen/sw6-category-links?label=packagist%20downloads&logo=composer)](//packagist.org/packages/runelaenen/sw6-category-links) +[![GitHub Issues](https://img.shields.io/github/issues/runelaenen/sw6-category-links?logo=github)](https://github.com/runelaenen/sw6-category-links/issues) +[![GitHub Stars](https://img.shields.io/github/stars/runelaenen/sw6-category-links?logo=github)](https://github.com/runelaenen/sw6-category-links/stargazers) +[![License](https://poser.pugx.org/runelaenen/sw6-category-links/license)](//packagist.org/packages/runelaenen/sw6-category-links) + +![Category Links plugin for Shopware 6](https://user-images.githubusercontent.com/3930922/109384793-9529e600-78ef-11eb-9927-b0a89867e26f.png) + +Link your categories automatically to another Shopware category. No more typo's in manually entered urls, no more URL changes, ... + +Use this plugin to put your footer categories in your header, or vice versa! + +## How to install +### Composer install (recommended) +``` +composer require runelaenen/sw6-category-links +bin/console plugin:refresh +bin/console plugin:install --activate RuneLaenenCategoryLinks +``` +Builing the javascript & css will still be needed. +``` +bin/build.sh +``` +#### Plugin update (composer) +``` +composer update runelaenen/sw6-category-links +bin/console plugin:update RuneLaenenCategoryLinks +``` +Builing the javascript & css will still be needed. +``` +bin/build.sh +``` + +### .zip install +1. Download the latest RuneLaenenCategoryLinks.zip from the [latest release](https://github.com/runelaenen/sw6-category-links/releases/latest). +2. Upload the zip in the Shopware Administration +3. Install & Activate the plugin + +#### Plugin update (zip) +1. Download the latest RuneLaenenCategoryLinks.zip from the [latest release](https://github.com/runelaenen/sw6-category-links/releases/latest). +2. Upload the zip in the Shopware Administration +3. Update the plugin diff --git a/bin/fix-ecs.sh b/bin/fix-ecs.sh new file mode 100644 index 0000000..177c69c --- /dev/null +++ b/bin/fix-ecs.sh @@ -0,0 +1,3 @@ +#!/usr/bin/env bash +echo "Fixing ecs errors" +php ../../../dev-ops/analyze/vendor/bin/ecs check --fix --config=../../../vendor/shopware/platform/easy-coding-standard.yml . --fix