diff --git a/doc/RunningBuilding.md b/doc/RunningBuilding.md index a08e933..7148043 100644 --- a/doc/RunningBuilding.md +++ b/doc/RunningBuilding.md @@ -8,3 +8,23 @@ - Navigate to the project's root folder using the command line - Run the command: `npm i` to install all the dependencies - Run the command: `npm run build`, the generated files will be placed inside `/bin` +--- + +# Publishing the project +- Since we are publishing a new version of the website, we should increment the version number. For sky-screenshot-stats we use the [Semantic Versioning](https://semver.org/) convention to update the version number. + - In summary: + - Given a version number MAJOR.MINOR.PATCH, increment the: + - MAJOR version when making major (breaking) changes. + - MINOR version when adding new features or improvements. + - PATCH version when making bugfixes or small improvements. + + +- Edit package.json to update the version number +- Run `npm i` +- Run `npm run build` +- Commit and push the changes +- Change your branch to the `website` branch. +- Remove all the files of the previous version of the website +- Copy the contents of the bin folder, to the root folder +- Commit and push the changes +- Now you can switch back to the `master` branch diff --git a/package-lock.json b/package-lock.json index 77a0258..8e7dcef 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "sky-screenshot-stats", - "version": "1.0.1", + "version": "1.0.2", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "sky-screenshot-stats", - "version": "1.0.1", + "version": "1.0.2", "license": "LGPL-3.0-only", "devDependencies": { "@parcel/packager-raw-url": "^2.0.0", diff --git a/package.json b/package.json index d62591b..65103b6 100644 --- a/package.json +++ b/package.json @@ -1,13 +1,13 @@ { "name": "sky-screenshot-stats", "browserslist": ["> 0.5%", "last 2 versions", "not dead"], - "version": "1.0.1", + "version": "1.0.2", "description": "", "keywords": "", "license": "LGPL-3.0-only", "author": "jam54", "scripts": { - "build": "rimraf ./bin && parcel build index.html --dist-dir ./bin", + "build": "rimraf ./bin && parcel build index.html --public-url='./' --dist-dir ./bin", "dev": "rimraf ./dist && parcel index.html --dist-dir ./dist --open", "start": "npm run build && npm run dev", "test": "echo \"Error: no test specified\" && exit 1"