diff --git a/CHANGELOG.md b/CHANGELOG.md index d8ffe8ff2d659b78f3e709cd3339718d5dcac1f6..c28c50154cb3e339a2772d2c5b9ce8ca158f20f5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,15 +2,16 @@ ### Features -* support meanTimeToMerge for MR analytics ([dc56e46](https://gitlab.com/gitlab-org/glql/commit/dc56e46ff0cc08d8db27eb4f6540f1d0db5aace1)) -* support Nullable type for work item epics ([08dda94](https://gitlab.com/gitlab-org/glql/commit/08dda94ebe89480eaf101940055c353500cfc742)) -* support parent field in work items API ([a3d5f11](https://gitlab.com/gitlab-org/glql/commit/a3d5f116b8b591e0c72fdf448d94657424be18bf)) +- support meanTimeToMerge for MR analytics ([dc56e46](https://gitlab.com/gitlab-org/glql/commit/dc56e46ff0cc08d8db27eb4f6540f1d0db5aace1)) +- support Nullable type for work item epics ([08dda94](https://gitlab.com/gitlab-org/glql/commit/08dda94ebe89480eaf101940055c353500cfc742)) +- support parent field in work items API ([a3d5f11](https://gitlab.com/gitlab-org/glql/commit/a3d5f116b8b591e0c72fdf448d94657424be18bf)) ### Bug Fixes -* copy aggregate as well when cloning ([768288e](https://gitlab.com/gitlab-org/glql/commit/768288e7b400aff7d73b7c0aa7d66c029fe8e02c)) -* do not allow nullable for work item epics ([5cae08f](https://gitlab.com/gitlab-org/glql/commit/5cae08f81662d46f362467a47cfeafcd2182fc08)) -* make fields optional in aggregate queries ([8eb3374](https://gitlab.com/gitlab-org/glql/commit/8eb3374d43c4a417f9df7fc66c9bbaff62ba3632)) +- copy aggregate as well when cloning ([768288e](https://gitlab.com/gitlab-org/glql/commit/768288e7b400aff7d73b7c0aa7d66c029fe8e02c)) +- do not allow nullable for work item epics ([5cae08f](https://gitlab.com/gitlab-org/glql/commit/5cae08f81662d46f362467a47cfeafcd2182fc08)) +- make fields optional in aggregate queries ([8eb3374](https://gitlab.com/gitlab-org/glql/commit/8eb3374d43c4a417f9df7fc66c9bbaff62ba3632)) + ## [0.20.8](https://gitlab.com/gitlab-org/glql/compare/v0.20.7...v0.20.8) (2025-09-03) ### Features diff --git a/README.md b/README.md index 03b61f8dac0bd7f5c02e783f0dfbb299a682b560..870204a1653bf4e019f5bf31b662b581f7049895 100644 --- a/README.md +++ b/README.md @@ -43,23 +43,20 @@ Import and use the module: ### Running the Example -Clone the repo and install the dev dependencies: +Clone the repo, then install the dev dependencies, build the WASM target, and serve the `npm/` directory: ```sh npm install +cargo install wasm-pack +rustup target add wasm32-unknown-unknown +wasm-pack build --target web +npx wds -r npm/ ``` -Build the module: - -``` -npm run build -``` - -Start the server of your choice. E.g.`wds`: - -```sh -npx wds -``` +> [!tip] Tip +> +> You can switch between legacy issues query and work items query by setting the +> `glqlWorkItems` feature flag in `index.html` to `true` or `false`. ## Development @@ -165,25 +162,6 @@ cargo clippy -- -D warnings This will treat all warnings as errors and prevent the code from building if any warnings are found. -### Examples - -Build and launch `npm/index.html` to test the GLQL -> GraphQL compiler: - -```bash -cargo install wasm-pack -rustup target add wasm32-unknown-unknown -wasm-pack build --target web -cd npm -npm install -npm run build -npx wds -``` - -> [!tip] Tip -> -> You can switch between legacy issues query and work items query by setting the -> `glqlWorkItems` feature flag in `index.html` to `true` or `false`. - ### End-to-End Testing When making changes to the GLQL Rust codebase, you can follow these steps to test your modifications end-to-end in [GitLab GDK](https://gitlab.com/gitlab-org/gitlab-development-kit):