Skip to content

Commit

Permalink
add relevant files for the repo section of the integration checklist …
Browse files Browse the repository at this point in the history
…(#58)

* add relevant files for the repo section of the integration checklist

* pr change requests

* final update from magento to kibocommerce
  • Loading branch information
cmcmannus-kibo authored and kibo-kevinwatts committed Sep 10, 2021
1 parent d1715e8 commit b4e6a0d
Show file tree
Hide file tree
Showing 15 changed files with 104 additions and 45 deletions.
8 changes: 4 additions & 4 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"projectName": "<% INTEGRATION %>",
"projectName": "kibocommerce",
"projectOwner": "vuestorefront",
"repoType": "github",
"repoHost": "https://github.com",
"files": [
"README.md"
],
"imageSize": 80,
"commit": false,
"imageSize": 100,
"commit": true,
"commitConvention": "angular",
"contributors": [],
"contributorsPerLine": 5
"contributorsPerLine": 6
}
6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to @vuestorefront/<% INTEGRATION %>
# Contributing to @vuestorefront/kibocommerce
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

- Reporting a bug
Expand All @@ -13,8 +13,8 @@ We use github to host code, to track issues and feature requests, as well as acc
## Any contributions you make will be under the MIT Software License
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.

## Report bugs using Github's [issues](https://github.com/vuestorefront/<% INTEGRATION %>/issues)
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/vuestorefront/<% INTEGRATION %>/issues/new); it's that easy!
## Report bugs using Github's [issues](https://github.com/vuestorefront/kibocommerce/issues)
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/vuestorefront/kibocommerce/issues/new); it's that easy!

## Write bug reports with detail, background, and sample code
**Great Bug Reports** tend to have:
Expand Down
42 changes: 21 additions & 21 deletions .github/ISSUE_TEMPLATE/1.bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report, please make sure to [search for existing issues](https://github.com/vuestorefront/<% REPOSITORY %>/issues) before filing a new one!
Thanks for taking the time to fill out this bug report, please make sure to [search for existing issues](https://github.com/vuestorefront/kibocommerce/issues) before filing a new one!
- type: textarea
id: whattoexpect
attributes:
Expand Down Expand Up @@ -41,28 +41,28 @@ body:
required: false
- type: input
attributes:
label: What version of <% INTEGRATION %> integration are you using?
label: What version of kibocommerce are you using?
description: 'For example: 1.0.0'
validations:
required: true
- type: input
attributes:
label: What version of Node.js are you using?
description: 'For example: 14.0.0'
validations:
required: true
- type: input
attributes:
label: What browser (and version) are you using?
description: 'For example: Chrome, Safari'
validations:
required: true
- type: input
attributes:
label: What operating system (and version) are you using?
description: 'For example: macOS, Windows'
validations:
required: true
- type: input
attributes:
label: What version of Node.js are you using?
description: 'For example: 12.0.0'
validations:
required: true
- type: input
attributes:
label: What browser (and version) are you using?
description: 'For example: Chrome, Safari'
validations:
required: true
- type: input
attributes:
label: What operating system (and version) are you using?
description: 'For example: macOS, Windows'
validations:
required: true
- type: textarea
id: logs
attributes:
Expand All @@ -73,7 +73,7 @@ body:
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront/<% REPOSITORY %>/blob/master/CODE_OF_CONDUCT.md)
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront/kibocommerce/blob/master/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/2.documentation-issue.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ body:
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront/<% INTEGRATION %>/blob/master/CODE_OF_CONDUCT.md)
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront/kibocommerce/blob/master/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/3.feature-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ body:
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront/<% INTEGRATION %>/blob/master/CODE_OF_CONDUCT.md)
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront/kibocommerce/blob/master/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/4.question.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ body:
required: true
- type: input
attributes:
label: What version of <% INTEGRATION %> integration are you using?
label: What version of kibocommerce are you using?
description: 'For example: 1.0.0'
validations:
required: true
Expand Down
9 changes: 9 additions & 0 deletions .github/lock.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Configuration for lock-threads - https://github.com/dessant/lock-threads
# disable lock bot for now
daysUntilLock: 3650
exemptLabels: []
lockLabel: false
lockComment: >
This thread has been automatically locked since there has not been
any recent activity after it was closed. Please open a new issue for
related bugs.
20 changes: 20 additions & 0 deletions .github/stale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Configuration for probot-stale - https://github.com/probot/stale
daysUntilStale: 30
daysUntilClose: 7
staleLabel: stale
exemptLabels:
- "cmty:feature-request"
- "feature-request"
- "WIP"
- "pending"
- "discussion"
exemptAssignees: true
only: issues
markComment: >
Thanks for your contribution to @vue-storefront/kibocommerce!
This issue has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs.
If you would like this issue to remain open:
1. Verify that you can still reproduce the issue in the latest version
1. Comment the steps to reproduce it
Issues that are labeled as `pending` will not be automatically marked as stale.
14 changes: 14 additions & 0 deletions .github/workflows/assingPrToAuthor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: PR to Author
on:
pull_request:
types: [opened, ready_for_review, edited, synchronize]

jobs:
assignAuthor:
name: Assing
runs-on: ubuntu-latest
steps:
- uses: samspills/[email protected]
if: github.event_name == 'pull_request' && github.event.action == 'opened'
with:
repo-token: '${{ secrets.GITHUB_TOKEN }}'
14 changes: 14 additions & 0 deletions .github/workflows/conventionalPrName.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Commitlint
on:
pull_request:
types: ['opened', 'edited', 'reopened', 'synchronize']

jobs:
lint:
name: Validate PR Title (conventional)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install Dependencies
run: npm install @commitlint/config-conventional
- uses: JulienKode/[email protected]
7 changes: 4 additions & 3 deletions .github/workflows/docs-deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
- name: Build and publish docker image
uses: elgohr/Publish-Docker-Github-Action@master
with:
name: docs-storefrontcloud-io/v2-<% INTEGRATION %>:${{ steps.get_version.outputs.VERSION }}
name: docs-storefrontcloud-io/kibocommerce:${{ steps.get_version.outputs.VERSION }}
registry: registry.storefrontcloud.io
username: ${{ secrets.DOCS_CLOUD_USERNAME }}
password: ${{ secrets.DOCS_CLOUD_PASSWORD }}
Expand All @@ -31,6 +31,7 @@ jobs:
buildoptions: "--compress"

deploy:
if: contains(github.event.pull_request.labels.*.name, 'release') && contains('bloodf|alefbarbeli|domideimel|LiorLindvor|filrak|filipsobol|andrzejewsky|', github.actor)
runs-on: ubuntu-latest
needs: build
steps:
Expand All @@ -49,9 +50,9 @@ jobs:
target_url: https://docs.europe-west1.gcp.storefrontcloud.io/v2
environment: production
initial_status: in_progress
- name: Deploy on docs.europe-west1.gcp.storefrontcloud.io/<% INTEGRATION %>
- name: Deploy on docs.europe-west1.gcp.storefrontcloud.io/kibocommerce
run: |
if curl -s -H 'X-User-Id: ${{ secrets.DOCS_CLOUD_USERNAME }}' -H 'X-Api-Key: ${{ secrets.DOCS_CLOUD_PASSWORD }}' -H 'Content-Type: application/json' -X POST -d '{"code":"docs","region":"europe-west1.gcp","additionalApps":{"apps":[{"name":"docs-v2-<% INTEGRATION %>","tag":"${{ steps.get_version.outputs.VERSION }}","image":"registry.storefrontcloud.io/docs-storefrontcloud-io/v2-<% INTEGRATION %>","path":"/<% INTEGRATION %>","port":"80"}]}}' https://farmer.storefrontcloud.io/instances | grep -q '{"code":200,"result":"Instance updated!"}'; then
if curl -s -H 'X-User-Id: ${{ secrets.DOCS_CLOUD_USERNAME }}' -H 'X-Api-Key: ${{ secrets.DOCS_CLOUD_PASSWORD }}' -H 'Content-Type: application/json' -X POST -d '{"code":"docs","region":"europe-west1.gcp","additionalApps":{"apps":[{"name":"docs-v2-kibocommerce","tag":"${{ steps.get_version.outputs.VERSION }}","image":"registry.storefrontcloud.io/docs-storefrontcloud-io/v2-kibocommerce","path":"/kibocommerce","port":"80"}]}}' https://farmer.storefrontcloud.io/instances | grep -q '{"code":200,"result":"Instance updated!"}'; then
echo "Instance updated"
else
echo "Something went wrong during the update process..."
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Publish Packages on NPM
name: Gitflow Merge & Publish Packages on NPM
on:
workflow_dispatch:
inputs:
Expand All @@ -19,7 +19,7 @@ jobs:
- name: Setup node
uses: actions/setup-node@v2
with:
node-version: '14'
node-version: "14"
registry-url: "https://registry.npmjs.org/"
scope: "@vue-storefront"
- run: echo "" >> .npmrc && echo "@vue-storefront:registry=https://registry.npmjs.org/" >> .npmrc
Expand Down
4 changes: 2 additions & 2 deletions .vuestorefrontcloud/docker/docs/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ WORKDIR /var/www
COPY . .

RUN npm install \
&& sed -i "s/base: '\/',/base: '\/<% INTEGRATION %>\/',/g" ./.vuepress/config.js \
&& sed -i "s/base: '\/',/base: '\/kibocommerce\/',/g" ./.vuepress/config.js \
&& cat ./.vuepress/config.js \
&& npm run build

FROM nginx

COPY --from=build /var/www/.vuepress/dist /usr/share/nginx/html/<% INTEGRATION %>
COPY --from=build /var/www/.vuepress/dist /usr/share/nginx/html/kibocommerce
4 changes: 2 additions & 2 deletions .vuestorefrontcloud/docker/docs/build-docker.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
TAG=`git rev-parse HEAD`
docker build --progress plain -t registry.storefrontcloud.io/docs-storefrontcloud-io/v2-<% INTEGRATION %>:${TAG:0:8} -f Dockerfile ../../../docs
# docker push registry.storefrontcloud.io/docs-storefrontcloud-io/v2-<% INTEGRATION %>:${TAG:0:8}
docker build --progress plain -t registry.storefrontcloud.io/docs-storefrontcloud-io/kibocommerce:${TAG:0:8} -f Dockerfile ../../../docs
# docker push registry.storefrontcloud.io/docs-storefrontcloud-io/kibocommerce:${TAG:0:8}
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,27 @@
# Contributing

Yeay! You want to contribute to @vuestorefront/<% INTEGRATION %>. That's amazing! To smoothen everyone's experience involved with the project please take note of the following guidelines and rules.
Yeay! You want to contribute to @vuestorefront/kibocommerce. That's amazing! To smoothen everyone's experience involved with the project please take note of the following guidelines and rules.


## Found an Issue?

Thank you for reporting any issues you find. We do our best to test and make @vuestorefront/<% INTEGRATION %> as solid as possible, but any reported issue is a real help.
Thank you for reporting any issues you find. We do our best to test and make @vuestorefront/kibocommerce as solid as possible, but any reported issue is a real help.

Please follow these guidelines when reporting issues:

- Provide a title in the format of `<Error> when <Task>`
- Tag your issue with the tag `bug`
- Provide a short summary of what you are trying to do
- Provide the log of the encountered error if applicable
- Provide the exact version of @vuestorefront/<% INTEGRATION %>.
- Provide the exact version of @vuestorefront/kibocommerce.
- Be awesome and consider contributing a [pull request](#want-to-contribute)

## Want to contribute?

You consider contributing changes to @vuestorefront/kibocommerce – we dig that!
Please consider these guidelines when filing a pull request:

> @vuestorefront/<% INTEGRATION %> pull requests
> @vuestorefront/kibocommerce pull requests
- Follow the [Coding Rules](#coding-rules)
- Follow the [Commit Rules](#commit-rules)
Expand All @@ -35,7 +36,7 @@ Please consider these guidelines when filing a pull request:

## Coding Rules

To keep the code base of @vuestorefront/<% INTEGRATION %> neat and tidy the following rules apply to every change
To keep the code base of @vuestorefront/kibocommerce neat and tidy the following rules apply to every change

> Coding standards
Expand Down

0 comments on commit b4e6a0d

Please sign in to comment.