diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 26b5a863d..d3c4988a5 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 1.0.1 +current_version = 1.0.2 [bumpversion:file:./README.md] diff --git a/Makefile b/Makefile index 4b966c8c6..2edece749 100644 --- a/Makefile +++ b/Makefile @@ -76,6 +76,20 @@ typecheck: poetry run mypy test/ poetry run mypy tools/ +# ----------------------------------------------------------------------------- +# Frontend QA +# ----------------------------------------------------------------------------- + +# Lint frontend source code +.PHONY: lint-frontend +lint-frontend: + cd mlte/frontend/nuxt-app && npm run lint + +# Typecheck frontend source code +.PHONY: typecheck-frontend +typecheck-frontend: + cd mlte/frontend/nuxt-app && npx vue-tsc + # ----------------------------------------------------------------------------- # Unit Tests # ----------------------------------------------------------------------------- diff --git a/README.md b/README.md index 0ded38d74..3f8dd5f6c 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ `mlte` (pronounced "melt") is a framework and infrastructure for machine learning evaluation. -![Version Badge](https://img.shields.io/badge/release-v1.0.1-e19b38) +![Version Badge](https://img.shields.io/badge/release-v1.0.2-e19b38) [![Code Style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Tests](https://github.com/turingcompl33t/mlte/actions/workflows/ci.yaml/badge.svg)](https://github.com/turingcompl33t/mlte/actions/workflows/ci.yaml) [![Documentation Status](https://readthedocs.org/projects/mlte/badge/?version=latest)](https://mlte.readthedocs.io/en/latest/?badge=latest) diff --git a/build.sh b/build.sh index 4eb265fd1..79a3c9b46 100644 --- a/build.sh +++ b/build.sh @@ -6,4 +6,4 @@ cd mlte/frontend/nuxt-app && npm run build cd ../../../ poetry build -twine check dist/* +poetry run twine check dist/* diff --git a/docs/docs/development.md b/docs/docs/development.md index 07543201d..56a147be4 100644 --- a/docs/docs/development.md +++ b/docs/docs/development.md @@ -189,37 +189,40 @@ $ npx gulp compile $ npx gulp init ``` -If there are issues with `npm install`, try this instead: - -```bash -$ npm install --ignore-scripts -$ npm install -$ npx gulp compile -$ npx gulp init -``` - Now the environment is set up and the front end can be run with the following command: ```bash $ npm run dev ``` -This will run the front end at `http://localhost:3000` so be sure to specify that as an allowed origin when running the backend. The backend can be run with a command like this one (using a file system store, in the local ./store folder): +This will run the front end at `http://localhost:3000`. The backend can be run with a command like this one (using a file system store, in the local ./store folder): ```bash -$ mlte backend --store-uri fs://store --allowed-origins http://localhost:3000 +$ mlte backend --store-uri fs://store ``` ### Front End Formatting and Linting -We format and lint all .vue, .js, and .ts files with ESLint, which can be run locally from the root of the nuxt application. +We format and lint all .vue, .js, and .ts files with ESLint, which can be run from the root of the repository with: + +```bash +$ make lint-frontend +``` + +Or manually from the root of the nuxt application: ```bash $ npm run lint ``` ### Front End Static Type Checking -All typescript code takes advantage of static typing. This type checking can be done by running the following command: +All typescript code takes advantage of static typing. This type checking can be done by running the following command from the root of the repository: + +```bash +$ make typecheck-frontend +``` + +Or manually from the root of the nuxt application: ```bash $ npx vue-tsc @@ -259,11 +262,7 @@ Bumping the version for a new release can be accomplished with: $ bumpversion patch ``` -where `patch` may be replaced with `minor` or `major` as appropriate for the release. You may need to use: - -```bash -$ bumpversion --allow-dirty patch -``` +where `patch` may be replaced with `minor` or `major` as appropriate for the release. Be sure to have no other pending changes or this may fail. Also, bupmversion will change all instances of the current version to the new one in the files it has been configured to do so, so if you have other text in these files which happens to match the current version, it will be incorrectly changed. Manually inspect changes after running this tool, and discard any incorrect ones. ### Publishing diff --git a/docs/docs/index.md b/docs/docs/index.md index 2ac187ac6..4ddce8bd4 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -44,7 +44,7 @@ If results are not satisfactory, more negotiation is required to determine if re ## MLTE Metadata -- Version: 1.0.1 +- Version: 1.0.2 - Contact Email: mlte dot team dot info at gmail dot com - Citations: While not required, it is highly encouraged and greatly appreciated if you cite our paper when you use `MLTE` for academic research. diff --git a/mlte/frontend/nuxt-app/package.json b/mlte/frontend/nuxt-app/package.json index d9f08ac30..cd952a2f3 100644 --- a/mlte/frontend/nuxt-app/package.json +++ b/mlte/frontend/nuxt-app/package.json @@ -1,6 +1,6 @@ { "name": "nuxt-app", - "version": "1.0.1", + "version": "1.0.2", "private": true, "scripts": { "build": "nuxi generate", diff --git a/pyproject.toml b/pyproject.toml index 226c48e8e..5aed35c56 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api" [tool.poetry] name = "mlte-python" -version = "1.0.1" +version = "1.0.2" description = "An infrastructure for machine learning test and evaluation." authors = ["MLTE Engineers"] readme = "README.md"