Merge pull request #22 from LottieFiles/develop

samuelOsborne · web-flow · commit 3efe5ff8f2cd · 2022-05-03T10:11:13.000+02:00
Changesets + dual-deployment and bounce mode
diff --git a/.changeset/README.md b/.changeset/README.md
@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@2.0.0/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "master",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}
diff --git a/.changeset/moody-onions-prove.md b/.changeset/moody-onions-prove.md
@@ -0,0 +1,5 @@
+---
+"@lottiefiles/vue-lottie-player": patch
+---
+
+added changesets and dual deploy
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -2,24 +2,22 @@ name: Release
 
 on:
   push:
-    branches: [master, beta]
+    branches: [master]
 
 jobs:
-  release:
-    name: Release
-
+  build:
     runs-on: ubuntu-latest
+    timeout-minutes: 15
 
     strategy:
       matrix:
-        node-version: [12.x]
+        node-version: [14.x]
 
     steps:
       - name: Checkout
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
-
       - name: Cache NPM
         uses: actions/cache@v2
         env:
@@ -33,12 +31,10 @@ jobs:
         uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
-          registry-url: 'https://npm.pkg.github.com'
-
+          registry-url: "https://npm.pkg.github.com"
       - name: Install dependencies
-        run:
-            yarn |
-            cd example && yarn
+        run: yarn |
+          cd example && yarn
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
@@ -47,6 +43,7 @@ jobs:
         run: yarn run serve-app
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
       - name: Build project and run tests
         continue-on-error: false
         run: yarn run run-tests
@@ -56,8 +53,44 @@ jobs:
       - name: Build project
         run: yarn build
 
-      - name: Release
-        run: yarn release
+  release-npm:
+    needs: build
+    name: Release npm
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: https://registry.npmjs.org/
+      - run: yarn install --frozen-lockfile
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPMJS_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPMJS_TOKEN }}
+          GIT_COMMIT: ${{ github.sha }}
+          GIT_AUTHOR_NAME: ${{ secrets.GIT_AUTHOR_NAME }}
+          GIT_AUTHOR_EMAIL: ${{ secrets.GIT_AUTHOR_EMAIL }}
+          GIT_COMMITTER_NAME: ${{ secrets.GIT_COMMITTER_NAME }}
+          GIT_COMMITTER_EMAIL: ${{ secrets.GIT_COMMITTER_EMAIL }}
+
+  release-gpr:
+    needs: build
+    name: Release gpr
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: https://npm.pkg.github.com/
+          scope: "@lottiefiles"
+      - run: yarn install --frozen-lockfile
+      - run:
+          echo "//npm.pkg.github.com:_authToken=${{ secrets.GITHUB_TOKEN }}" >
+          ~/.npmrc
+      - run: npm publish --@lottiefiles:registry=https://npm.pkg.github.com/
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,86 +1,82 @@
 # Changelog
-All notable changes to this project will be documented in this file.
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html), enforced with [semantic-release](https://github.com/semantic-release/semantic-release).
 
+## 1.0.6
 
-## [1.0.1](https://github.com/LottieFiles/lottie-vue/compare/v1.0.0...v1.0.1) (2022-03-08)
+### Patch Changes
+
+- added bounce mode and changesets
+- 49df023: added changesets and dual deploy
+  All notable changes to this project will be documented in this file.
+  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html), enforced with [semantic-release](https://github.com/semantic-release/semantic-release).
 
+## [1.0.1](https://github.com/LottieFiles/lottie-vue/compare/v1.0.0...v1.0.1) (2022-03-08)
 
 ### Bug Fixes
 
-* fixed css overriding page css ([80e29fd](https://github.com/LottieFiles/lottie-vue/commit/80e29fd31bb601ea12370c5a3252c9c78ad56d5a))
-* fixed missing spinner animation ([8405c26](https://github.com/LottieFiles/lottie-vue/commit/8405c2623df51969918ac832f8a8e3daf30ea989))
-* fixing deps issue in gh workflow ([020a5d2](https://github.com/LottieFiles/lottie-vue/commit/020a5d2ad8f89cee829932d3361dc818dc74eb6d))
-* restored default values to those of the readme ([1cb2f26](https://github.com/LottieFiles/lottie-vue/commit/1cb2f261f2a8a7bb6bf9bae018fc1dacfdf7ffe9))
-* updated packages, fixed player bug with controls, fixed css bundling bug ([47bbdb0](https://github.com/LottieFiles/lottie-vue/commit/47bbdb0ee51dd8771a078fb7370ce75acbf00d40))
+- fixed css overriding page css ([80e29fd](https://github.com/LottieFiles/lottie-vue/commit/80e29fd31bb601ea12370c5a3252c9c78ad56d5a))
+- fixed missing spinner animation ([8405c26](https://github.com/LottieFiles/lottie-vue/commit/8405c2623df51969918ac832f8a8e3daf30ea989))
+- fixing deps issue in gh workflow ([020a5d2](https://github.com/LottieFiles/lottie-vue/commit/020a5d2ad8f89cee829932d3361dc818dc74eb6d))
+- restored default values to those of the readme ([1cb2f26](https://github.com/LottieFiles/lottie-vue/commit/1cb2f261f2a8a7bb6bf9bae018fc1dacfdf7ffe9))
+- updated packages, fixed player bug with controls, fixed css bundling bug ([47bbdb0](https://github.com/LottieFiles/lottie-vue/commit/47bbdb0ee51dd8771a078fb7370ce75acbf00d40))
 
 ## [1.0.1](https://github.com/LottieFiles/lottie-vue/compare/v1.0.0...v1.0.1) (2022-03-04)
 
-
 ### Bug Fixes
 
-* fixed css overriding page css ([80e29fd](https://github.com/LottieFiles/lottie-vue/commit/80e29fd31bb601ea12370c5a3252c9c78ad56d5a))
-* restored default values to those of the readme ([1cb2f26](https://github.com/LottieFiles/lottie-vue/commit/1cb2f261f2a8a7bb6bf9bae018fc1dacfdf7ffe9))
-* updated packages, fixed player bug with controls, fixed css bundling bug ([47bbdb0](https://github.com/LottieFiles/lottie-vue/commit/47bbdb0ee51dd8771a078fb7370ce75acbf00d40))
+- fixed css overriding page css ([80e29fd](https://github.com/LottieFiles/lottie-vue/commit/80e29fd31bb601ea12370c5a3252c9c78ad56d5a))
+- restored default values to those of the readme ([1cb2f26](https://github.com/LottieFiles/lottie-vue/commit/1cb2f261f2a8a7bb6bf9bae018fc1dacfdf7ffe9))
+- updated packages, fixed player bug with controls, fixed css bundling bug ([47bbdb0](https://github.com/LottieFiles/lottie-vue/commit/47bbdb0ee51dd8771a078fb7370ce75acbf00d40))
 
 ## [1.0.1](https://github.com/LottieFiles/lottie-vue/compare/v1.0.0...v1.0.1) (2022-02-23)
 
-
 ### Bug Fixes
 
-* fixed css overriding page css ([80e29fd](https://github.com/LottieFiles/lottie-vue/commit/80e29fd31bb601ea12370c5a3252c9c78ad56d5a))
-* restored default values to those of the readme ([1cb2f26](https://github.com/LottieFiles/lottie-vue/commit/1cb2f261f2a8a7bb6bf9bae018fc1dacfdf7ffe9))
-* updated packages, fixed player bug with controls, fixed css bundling bug ([47bbdb0](https://github.com/LottieFiles/lottie-vue/commit/47bbdb0ee51dd8771a078fb7370ce75acbf00d40))
+- fixed css overriding page css ([80e29fd](https://github.com/LottieFiles/lottie-vue/commit/80e29fd31bb601ea12370c5a3252c9c78ad56d5a))
+- restored default values to those of the readme ([1cb2f26](https://github.com/LottieFiles/lottie-vue/commit/1cb2f261f2a8a7bb6bf9bae018fc1dacfdf7ffe9))
+- updated packages, fixed player bug with controls, fixed css bundling bug ([47bbdb0](https://github.com/LottieFiles/lottie-vue/commit/47bbdb0ee51dd8771a078fb7370ce75acbf00d40))
 
 ## [1.0.1](https://github.com/LottieFiles/lottie-vue/compare/v1.0.0...v1.0.1) (2022-02-23)
 
-
 ### Bug Fixes
 
-* fixed css overriding page css ([80e29fd](https://github.com/LottieFiles/lottie-vue/commit/80e29fd31bb601ea12370c5a3252c9c78ad56d5a))
-* restored default values to those of the readme ([1cb2f26](https://github.com/LottieFiles/lottie-vue/commit/1cb2f261f2a8a7bb6bf9bae018fc1dacfdf7ffe9))
-* updated packages, fixed player bug with controls, fixed css bundling bug ([47bbdb0](https://github.com/LottieFiles/lottie-vue/commit/47bbdb0ee51dd8771a078fb7370ce75acbf00d40))
+- fixed css overriding page css ([80e29fd](https://github.com/LottieFiles/lottie-vue/commit/80e29fd31bb601ea12370c5a3252c9c78ad56d5a))
+- restored default values to those of the readme ([1cb2f26](https://github.com/LottieFiles/lottie-vue/commit/1cb2f261f2a8a7bb6bf9bae018fc1dacfdf7ffe9))
+- updated packages, fixed player bug with controls, fixed css bundling bug ([47bbdb0](https://github.com/LottieFiles/lottie-vue/commit/47bbdb0ee51dd8771a078fb7370ce75acbf00d40))
 
 ## [1.0.4](https://github.com/LottieFiles/lottie-vue/compare/v1.0.0...v1.0.1) (2022-02-21)
 
-
 ### Bug Fixes
 
-* fixed css overriding page css ([80e29fd](https://github.com/LottieFiles/lottie-vue/commit/80e29fd31bb601ea12370c5a3252c9c78ad56d5a))
-* restored default values to those of the readme ([1cb2f26](https://github.com/LottieFiles/lottie-vue/commit/1cb2f261f2a8a7bb6bf9bae018fc1dacfdf7ffe9))
-* updated packages, fixed player bug with controls, fixed css bundling bug ([47bbdb0](https://github.com/LottieFiles/lottie-vue/commit/47bbdb0ee51dd8771a078fb7370ce75acbf00d40))
+- fixed css overriding page css ([80e29fd](https://github.com/LottieFiles/lottie-vue/commit/80e29fd31bb601ea12370c5a3252c9c78ad56d5a))
+- restored default values to those of the readme ([1cb2f26](https://github.com/LottieFiles/lottie-vue/commit/1cb2f261f2a8a7bb6bf9bae018fc1dacfdf7ffe9))
+- updated packages, fixed player bug with controls, fixed css bundling bug ([47bbdb0](https://github.com/LottieFiles/lottie-vue/commit/47bbdb0ee51dd8771a078fb7370ce75acbf00d40))
 
 ## [1.0.3](https://github.com/LottieFiles/lottie-vue/compare/v1.0.0...v1.0.1) (2022-02-16)
 
-
 ### Bug Fixes
 
-* fixed css overriding page css ([80e29fd](https://github.com/LottieFiles/lottie-vue/commit/80e29fd31bb601ea12370c5a3252c9c78ad56d5a))
-* updated packages, fixed player bug with controls, fixed css bundling bug ([47bbdb0](https://github.com/LottieFiles/lottie-vue/commit/47bbdb0ee51dd8771a078fb7370ce75acbf00d40))
+- fixed css overriding page css ([80e29fd](https://github.com/LottieFiles/lottie-vue/commit/80e29fd31bb601ea12370c5a3252c9c78ad56d5a))
+- updated packages, fixed player bug with controls, fixed css bundling bug ([47bbdb0](https://github.com/LottieFiles/lottie-vue/commit/47bbdb0ee51dd8771a078fb7370ce75acbf00d40))
 
 ## [1.0.2](https://github.com/LottieFiles/lottie-vue/compare/v1.0.1...v1.0.2) (2022-01-19)
 
-
 ### Bug Fixes
 
-* changed token var ([757798f](https://github.com/LottieFiles/lottie-vue/commit/757798f906b6ce594154187d0273b108197eb3af))
+- changed token var ([757798f](https://github.com/LottieFiles/lottie-vue/commit/757798f906b6ce594154187d0273b108197eb3af))
 
 ## [1.0.1](https://github.com/LottieFiles/lottie-vue/compare/v1.0.0...v1.0.1) (2022-01-18)
 
-
 ### Bug Fixes
 
-* updated packages, fixed player bug with controls, fixed css bundling bug ([47bbdb0](https://github.com/LottieFiles/lottie-vue/commit/47bbdb0ee51dd8771a078fb7370ce75acbf00d40))
+- updated packages, fixed player bug with controls, fixed css bundling bug ([47bbdb0](https://github.com/LottieFiles/lottie-vue/commit/47bbdb0ee51dd8771a078fb7370ce75acbf00d40))
 
 # 1.0.0 (2021-06-01)
 
-
 ### Bug Fixes
 
-* **removed dot lottie player:** removed dot lottie player ([5b5c0b5](https://github.com/LottieFiles/lottie-vue/commit/5b5c0b5f91fa96c6501e69c62d7473b18b3e9dd3))
-
+- **removed dot lottie player:** removed dot lottie player ([5b5c0b5](https://github.com/LottieFiles/lottie-vue/commit/5b5c0b5f91fa96c6501e69c62d7473b18b3e9dd3))
 
 ### Features
 
-* **bundling:** added bundling scripts and processes ([4ae9f6f](https://github.com/LottieFiles/lottie-vue/commit/4ae9f6fd101aaa10da2dfd23bf9d752ab9a71293))
-* example for using lottievue player done ([79f146a](https://github.com/LottieFiles/lottie-vue/commit/79f146a91fed1717c4df7a6b81d3ba7561cdacd2))
+- **bundling:** added bundling scripts and processes ([4ae9f6f](https://github.com/LottieFiles/lottie-vue/commit/4ae9f6fd101aaa10da2dfd23bf9d752ab9a71293))
+- example for using lottievue player done ([79f146a](https://github.com/LottieFiles/lottie-vue/commit/79f146a91fed1717c4df7a6b81d3ba7561cdacd2))
diff --git a/README.md b/README.md
@@ -184,6 +184,37 @@ set background color.
 #### Returns
 
 Type: `void`
+
+## Contributing
+
+We use changesets to maintain a changelog for this repository. When making any change to the codebase that impacts functionality or performance we require a changeset to be present.
+
+To add a changeset run:
+
+```
+yarn run changeset
+```
+
+And select the type of version bump you'd like (major, minor, path).
+
+You can document the change in detail and format it properly using Markdown by opening the ".md" file that the "yarn changeset" command created in the ".changeset" folder. Open the file, it should look something like this:
+
+```
+---
+"@lottiefiles/pkg1": minor
+"@lottiefiles/pkg2": major
+---
+
+This is where you document your **changes** using Markdown.
+
+- You can write
+- However you'd like
+- In as much detail as you'd like
+
+Aim to provide enough details so that team mates and future you can understand the changes and the context of the change.
+```
+
+You can commit your changes and the changeset to your branch and then create a pull request on the develop branch.
 ## License
 
 MIT License © LottieFiles.com
diff --git a/example/components/Home.vue b/example/components/Home.vue
@@ -1,20 +1,24 @@
 <template>
   <div>
-    <div style="display: flex; justify-content: center; align-content: center">
-    </div>
+    <div
+      style="display: flex; justify-content: center; align-content: center"
+    ></div>
     <div style="display: flex; justify-content: center; align-content: center">
       <h1>Welcome to LottieVue example</h1>
     </div>
     <br />
     <lottie-vue-player
       id="player-one"
-      :src="`https://assets10.lottiefiles.com/packages/lf20_tzjfwgud.json`"
+      :src="`https://assets9.lottiefiles.com/private_files/lf30_w3ku1h1i.json`"
       :theme="options.theme"
       :player-size="options.playerSize"
       :player-controls="true"
       :showColorPicker="true"
       :loop="true"
+      :speed="3"
       :autoplay="true"
+      mode="normal"
+      :background-color="options.backgroundColor"
       style="width: 100%; height: 400px"
     ></lottie-vue-player>
   </div>
@@ -28,7 +32,7 @@ export default {
       options: {
         minimizable: false,
         playerSize: "standard",
-        backgroundColor: "#fff",
+        backgroundColor: "#9dff97",
         backgroundStyle: "color",
         theme: {
           controlsView: "standard",
diff --git a/package.json b/package.json
@@ -4,6 +4,7 @@
   "description": "Lottie player wrapper for Vue.js by LottieFiles",
   "scripts": {
     "build": "vue-cli-service build --target lib --name @lottiefiles/vue-lottie-player ./src/index.js && rm ./dist/demo.html",
+    "build:dev": "vue-cli-service build --watch --inline-vue --target lib --name @lottiefiles/vue-lottie-player ./src/index.js && rm ./dist/demo.html",
     "build-with-coverage": "CODE_COVERAGE=true vue-cli-service build --target lib --name @lottiefiles/vue-lottie-player ./src/index.js && rm ./dist/demo.html",
     "release": "semantic-release",
     "run-tests": "yarn run build-with-coverage && yarn run start-cypress",
@@ -13,15 +14,20 @@
     "serve-app": "cd example && yarn && yarn run serve &",
     "start-cypress": "yarn run cypress run"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/LottieFiles/lottie-vue.git"
+  },
   "main": "dist/@lottiefiles/vue-lottie-player.common.js",
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@lottiefiles/lottie-player": "^1.0.4",
+    "@lottiefiles/lottie-player": "^1.5.7",
     "vue": "^2.6.12"
   },
   "devDependencies": {
+    "@changesets/cli": "^2.22.0",
     "@commitlint/cli": "^12.1.1",
     "@commitlint/config-conventional": "^12.1.1",
     "@cypress/code-coverage": "^3.9.12",
@@ -72,4 +78,4 @@
     "lottiefiles"
   ],
   "license": "MIT"
-}
+}
diff --git a/src/Player.vue b/src/Player.vue
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@lottiefiles/vue-lottie-player": patch
 +---
++
 +added changesets and dual deploy