@pixieset/versioning-js 1.0.13 → 2.0.1-alpha.1

package/README.md

@@ -1,87 +1,5 @@
 # Pixieset Laravel versioning
-This library is meant to augment the Laravel versioning approach created for Studio Manager.  This repository contains
-the front-end code for this project, and should be installed in conjunction with the backend work.
 
-The frontend part contains helpers that can be used to manage the versioning of resources in a frontend application, specifically, the handling of when there are version inconsistencies. 
+This library is an internal package meant for Pixieset application development.
 
-
-## Contents
-- [Pixieset Laravel versioning](#pixieset-laravel-versioning)
-  - [Contents](#contents)
-  - [Installation](#installation)
-  - [Usage](#usage)
-  - [Bundle development](#bundle-development)
-    - [Prerequisites](#prerequisites)
-    - [Installation](#installation-1)
-    - [Building](#building)
-    - [Pushing changes](#pushing-changes)
-  - [Footnotes](#footnotes)
----
-
-## Installation
-
-**Prerequisites**:
-
-Currently, this project supports Axios, Laravel, and Capacitor.  You must also have a working Sentry integration in your front-end code already, and you must have installed the backend version checking code.
-
-**Installation**:
-
-The built front-end distribution code for this project is currently publicly available on packagist.   Update your `package.json` file to include the following:
-
-```json
-{
-  "dependencies": {
-    "@pixieset/versioning-js": "^1.0"
-  }
-}
-```
-
-Then run `yarn install` to install the package.
-
-## Usage
-
-For information on versioning usage, see [the Pixieset internal documentation](https://www.notion.so/pixieset/Studio-Manager-Resource-Versioning-WIP-d702c157a24e496e92f869eca2015c1b).
-
-## Bundle development
-
-This section is for developers who want to make changes to the bundle.  It is assumed that you have a Laravel application that you are using to test the changes.
-
-This package uses a Makefile to assist in building the package.  See that file for the commands available, or run `make help` to see a list of available commands in that subfolder.
-
-### Prerequisites
-To build the frontend package, you will need to have the following installed:
-- nodejs, version 18 or higher, with yarn globally.
-- Follow the directions [here](https://classic.yarnpkg.com/lang/en/docs/cli/version/), as well, if you intend to commit.
-
-### Installation
-To make the frontend available locally, you can use the following steps:
-
-1. Clone this repository into a directory of your Laravel application (if you haven't already done so).   Preferably one that will not pollute your primary git source tree.  We're going to use symlinks to connect it in a moment.
-2. In the `versioning-js` portion of the package, invoke `yarn link`.  This will make the package available for local linking and modification.
-3. In your service provider where you are using the package (e.g. Studio Manager), invoke `yarn link @pixieset/versioning-js`.   That will cause `yarn` to symlink the two, so you can make changes locally, and see them every time you run `make build`.
-4. Run your local service provider front end `*-watch` task, to start hot-rebuilding your code based on file changes.
-5. When done, run `yarn unlink @pixieset/versioning-js` within the service provider, to stop using linked code.  Commit and tag your changes. 
-
-
-### Building
-
-The frontend package contains build artifacts in the `dist` subfolder, which are compiled typescript files.  These files are what you should be importing into your Vue components.   Any changes you make to the typescript files in the `src` directory should be compiled into the `dist` directory when you run `make build`.
-
-### Pushing changes
-
-This project uses the [yarn version](https://classic.yarnpkg.com/lang/en/docs/cli/version/) tooling to publish changes. You should have set up your local environment as specified in the prerequisites.
-
-First, set up your pull request, and confirm the changes you'd like to make.   Use `yarn link` as described above, to ensure the changes actually work.
-
-Once the pull request is merged, use `yarn version` as per the yarn documentation to create and publish a new front-end version.  This should:
-
-1. Create a new version number in package.json
-2. Create a new git tag, with the same value.
-
-Push the results of this, using `git push --tags`.   This will trigger the pipeline to create a new build version automatically, and deploy it to NPM for installation.
-
-Remember to unlink yarn before you try to install it.
-
-## Footnotes
-
-- For more information on the technical proposal, see [here](https://www.notion.so/pixieset/Technical-Proposal-SM-API-resource-versioning-41be2336e8f74ce5b1bdbaa04aa04a62?pm=c).
+For information on versioning usage, see [the Pixieset documentation](https://www.notion.so/pixieset/Studio-Manager-Resource-Versioning-WIP-d702c157a24e496e92f869eca2015c1b).

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "@pixieset/versioning-js",
-  "version": "1.0.13",
+  "version": "2.0.1-alpha.1",
   "description": "Front end support for Pixieset versioning",
   "main": "index.js",
   "repository": {
     "type": "git",
-    "url": "git@bitbucket.org:pixieset/versioning-js.git"
+    "url": "git@gitlab.com:pixieset/packages/npm/versioning-js.git"
   },
   "author": "Aron Beal <aron.beal@pixieset.com>",
   "license": "UNLICENSED",
   "files": [
-    "dist"
+    "dist",
+    "README.md",
+    "LICENSE"
   ],
   "devDependencies": {
     "@types/axios": "^0.14",
@@ -48,7 +50,7 @@
     "versioning"
   ],
   "bugs": {
-    "url": "https://bitbucket.org/pixieset/versioning-js/issues"
+    "url": "https://gitlab.com/pixieset/packages/npm/versioning-js/-/issues"
   },
-  "homepage": "https://bitbucket.org/pixieset/versioning-js#readme"
+  "homepage": "https://gitlab.com/pixieset/packages/npm/versioning-js"
 }