diff --git a/.github/workflows/deploy_to_npm.yml b/.github/workflows/deploy_to_npm.yml index 85ced38..ecd3790 100644 --- a/.github/workflows/deploy_to_npm.yml +++ b/.github/workflows/deploy_to_npm.yml @@ -83,16 +83,15 @@ jobs: cp ../../pnpm-lock.yaml . git status pnpm publish --provenance --access=public --no-git-checks - - mkdir --parents "${{ needs.open-release.outputs.VERSION }}/docs" - mv target/apidocs "${{ needs.open-release.outputs.VERSION }}/docs/api" env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} - - name: Commit changes + - name: Publish documentation run: | git checkout gh-pages -f echo "INITIAL_GH_PAGES_POSITION=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT" + mkdir --parents "${{ needs.open-release.outputs.VERSION }}/docs" + mv target/apidocs "${{ needs.open-release.outputs.VERSION }}/docs/api" git add "${{ needs.open-release.outputs.VERSION }}/docs/api" git commit -m "Released version ${{ needs.open-release.outputs.VERSION }}" git push diff --git a/README.md b/README.md index d563ee5..d925764 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ [![npm version](https://badge.fury.io/js/%40cowwoc%2Frequirements.svg)](https://badge.fury.io/js/%40cowwoc%2Frequirements) [![build-status](https://github.com/cowwoc/requirements.js/workflows/Build/badge.svg)](https://github.com/cowwoc/requirements.js/actions?query=workflow%3ABuild) -# checklist Requirements API +# checklist Requirements API -[![API](https://img.shields.io/badge/api_docs-5B45D5.svg)](https://cowwoc.github.io/requirements.js/4.0.2/docs/api/) +[![API](https://img.shields.io/badge/api_docs-5B45D5.svg)](https://cowwoc.github.io/requirements.js/4.0.3/docs/api/) [![Changelog](https://img.shields.io/badge/changelog-A345D5.svg)](docs/Changelog.md) [![java](https://img.shields.io/badge/other%20languages-java-457FD5.svg)](../../../requirements.java) @@ -18,13 +18,13 @@ A [fluent API](https://en.m.wikipedia.org/docs/Fluent_interface) for enforcing To get started, add this dependency: ```shell -npm install --save @cowwoc/requirements@4.0.2 +npm install --save @cowwoc/requirements@4.0.3 ``` or [pnpm](https://pnpm.io/): ```shell -pnpm add @cowwoc/requirements@4.0.2 +pnpm add @cowwoc/requirements@4.0.3 ``` ## Usage Example @@ -146,11 +146,11 @@ This library offers the following features: Designed for discovery using your favorite IDE's auto-complete feature. The main entry points are: -* [requireThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.2/docs/api/module-DefaultRequirements.html#~requireThat) +* [requireThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.3/docs/api/module-DefaultRequirements.html#~requireThat) for method preconditions. -* [assertThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.2/docs/api/module-DefaultRequirements.html#~assertThat) +* [assertThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.3/docs/api/module-DefaultRequirements.html#~assertThat) for [class invariants, method postconditions and private methods](docs/Features.md#assertion-support). -* [checkIf(value, name)](https://cowwoc.github.io/requirements.js/4.0.2/docs/api/module-DefaultRequirements.html#~checkIf) +* [checkIf(value, name)](https://cowwoc.github.io/requirements.js/4.0.3/docs/api/module-DefaultRequirements.html#~checkIf) for multiple failures and customized error handling. See the [API documentation](https://cowwoc.github.io/requirements.java/10.0/docs/api/) for more details. diff --git a/docs/Features.md b/docs/Features.md index b19b0e4..aee5c09 100644 --- a/docs/Features.md +++ b/docs/Features.md @@ -99,7 +99,7 @@ requireThat(nameToAge, "nameToAge"). ## String diff When -a [String comparison](https://cowwoc.github.io/requirements.js/4.0.2/docs/api/ObjectVerifier.html#isEqualTo) +a [String comparison](https://cowwoc.github.io/requirements.js/4.0.3/docs/api/ObjectVerifier.html#isEqualTo) fails, the library outputs a diff of the values being compared. Depending on the terminal capability, you will see a [textual](Textual_Diff.md) or a colored diff. diff --git a/docs/String_Diff.md b/docs/String_Diff.md index 2e42f2d..5f3e4af 100644 --- a/docs/String_Diff.md +++ b/docs/String_Diff.md @@ -1,5 +1,5 @@ When -a [String comparison](https://cowwoc.github.io/requirements.js/4.0.2/docs/api/ObjectVerifier.html#isEqualTo) +a [String comparison](https://cowwoc.github.io/requirements.js/4.0.3/docs/api/ObjectVerifier.html#isEqualTo) fails, the library outputs a [diff](https://en.wikipedia.org/wiki/Diff) of the values being compared. Depending on the terminal capability, you will see a [Textual](Textual_Diff.md) or [Colored](Colored_Diff.md) diff --git a/package.json b/package.json index d6f9f46..e3a3133 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@cowwoc/requirements", - "version": "4.0.2", + "version": "4.0.3", "keywords": [ "preconditions", "postconditions",