Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: release main #352

Closed
wants to merge 2 commits into from
Closed

chore: release main #352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a9cd05
chore: release main
dialogporten-bot Sep 24, 2024
161245e
cleanup
arealmaas Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
249 changes: 249 additions & 0 deletions CHANGELOG.md
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "dialogporten-frontend",
"version": "1.0.0",
"version": "1.1.0",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Version inconsistency detected in multiple package.json files.

The following package.json files do not have the updated version 1.1.0:

  • ./packages/fastify-graphiql/package.json: null
  • ./packages/embeddable-markdown-html/package.json: null
  • ./packages/node-logger/package.json: 1.0.0
  • ./packages/bff-types-generated/package.json: null

Please update these files to ensure version consistency across the project.

Analysis chain

Version update approved, but verify consistency across the project.

The version bump from 1.0.0 to 1.1.0 is correct and aligns with the release objectives.

However, let's verify the consistency of this version update across the project:

Please ensure all packages are updated consistently to maintain version coherence.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify version consistency across the project

# Check the version in .release-please-manifest.json
echo "Checking .release-please-manifest.json:"
jq '.[""]' .release-please-manifest.json

# Check versions in all package.json files
echo -e "\nChecking all package.json files:"
fd package.json --exec jq '.version'

# List package.json files not at version 1.1.0
echo -e "\nListing package.json files not at version 1.1.0:"
fd package.json --exec bash -c 'version=$(jq -r .version "$1"); if [ "$version" != "1.1.0" ]; then echo "$(dirname "$1")/package.json: $version"; fi' _ {} \;

Length of output: 796

"private": true,
"scripts": {
"hooks:enable": "git config core.hooksPath .hooks",
Expand Down
59 changes: 59 additions & 0 deletions packages/bff/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Changelog

## [1.1.0](https://github.com/digdir/dialogporten-frontend/compare/bff-v1.0.0...bff-v1.1.0) (2024-09-24)


Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove extra blank lines for consistent formatting.

To improve the readability and consistency of the changelog, remove the extra blank lines at the following locations:

  1. Line 5: Remove one blank line between the version number and the Features section.
  2. Line 33: Remove one blank line between the Features and Bug Fixes sections.

Apply this diff to fix the formatting:

 ## [1.1.0](https://github.com/digdir/dialogporten-frontend/compare/bff-v1.0.0...bff-v1.1.0) (2024-09-23)
-

 ### Features

 * add graphql-request for fetching data with example ([#543](https://github.com/digdir/dialogporten-frontend/issues/543)) ([668eff9](https://github.com/digdir/dialogporten-frontend/commit/668eff9bff7d521c8032cb538528b8a8fb169ad4))
 ...
 * support multiselect filters ([4cd3311](https://github.com/digdir/dialogporten-frontend/commit/4cd3311ae0453a9ffc9cdfc0e7e7d55247a1e885))
-

 ### Bug Fixes

 * actually use the port variable ([d735613](https://github.com/digdir/dialogporten-frontend/commit/d735613b3d0aaa4ffec9a80110adacc211143e61))

This change will ensure a consistent single blank line between sections, improving the overall formatting of the changelog.

Also applies to: 33-33

Tools
Markdownlint

5-5: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)

Comment on lines +1 to +5
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick (assertive)

Remove extra blank lines for consistent formatting.

To improve the readability and consistency of the changelog, remove the extra blank lines at the following locations:

  1. Line 5: Remove one blank line between the version number and the Features section.
  2. Line 33: Remove one blank line between the Features and Bug Fixes sections.

Apply this diff to fix the formatting:

 # Changelog

 ## [1.1.0](https://github.com/digdir/dialogporten-frontend/compare/bff-v1.0.0...bff-v1.1.0) (2024-09-24)

-
 ### Features

 * add graphql-request for fetching data with example ([#543](https://github.com/digdir/dialogporten-frontend/issues/543)) ([668eff9](https://github.com/digdir/dialogporten-frontend/commit/668eff9bff7d521c8032cb538528b8a8fb169ad4))
 ...
 * support multiselect filters ([4cd3311](https://github.com/digdir/dialogporten-frontend/commit/4cd3311ae0453a9ffc9cdfc0e7e7d55247a1e885))

-
 ### Bug Fixes

 * actually use the port variable ([d735613](https://github.com/digdir/dialogporten-frontend/commit/d735613b3d0aaa4ffec9a80110adacc211143e61))

This change will ensure a consistent single blank line between sections, improving the overall formatting of the changelog.

Also applies to: 33-33

Tools
Markdownlint

5-5: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)

### Features

* add graphql-request for fetching data with example ([#543](https://github.com/digdir/dialogporten-frontend/issues/543)) ([668eff9](https://github.com/digdir/dialogporten-frontend/commit/668eff9bff7d521c8032cb538528b8a8fb169ad4))
* add log out feature ([8a65a21](https://github.com/digdir/dialogporten-frontend/commit/8a65a2165983d87ba560bdb068daa6d950dfa8a3))
* Added fromView functionality, removed compression in query params ([#770](https://github.com/digdir/dialogporten-frontend/issues/770)) ([85ca8d5](https://github.com/digdir/dialogporten-frontend/commit/85ca8d57207614b684ff2838a835138921e832e5))
* **auth:** Add logout route ([#456](https://github.com/digdir/dialogporten-frontend/issues/456)) ([8a65a21](https://github.com/digdir/dialogporten-frontend/commit/8a65a2165983d87ba560bdb068daa6d950dfa8a3))
* **auth:** refresh auth tokens when they expire ([#457](https://github.com/digdir/dialogporten-frontend/issues/457)) ([286544d](https://github.com/digdir/dialogporten-frontend/commit/286544d557dcd1751beec54eb52a2391df63af3e))
* **bff:** add health checks ([#1099](https://github.com/digdir/dialogporten-frontend/issues/1099)) ([4d0cfde](https://github.com/digdir/dialogporten-frontend/commit/4d0cfdee9675fb0317045e77a0362ce1eaf2c10e))
* **bff:** update DB migration code [#553](https://github.com/digdir/dialogporten-frontend/issues/553) ([900e392](https://github.com/digdir/dialogporten-frontend/commit/900e392fc6867003caaf936909cb7fc0ebfc85e9))
* **bff:** use node logger ([#1043](https://github.com/digdir/dialogporten-frontend/issues/1043)) ([d2f359c](https://github.com/digdir/dialogporten-frontend/commit/d2f359c5f24158a480cfb5689f9f03beb68c4ea2))
* **bff:** use node-logger in fastify ([#1063](https://github.com/digdir/dialogporten-frontend/issues/1063)) ([70b5e2c](https://github.com/digdir/dialogporten-frontend/commit/70b5e2c1039b840e5c8523f4d5bfa599004eeff5))
* **bff:** use node:timers ([d787f31](https://github.com/digdir/dialogporten-frontend/commit/d787f31b3f34f7d07ca4d0d67baa741aba4dc769))
* codegen for frontend based on GraphQL types in the BFF ([#541](https://github.com/digdir/dialogporten-frontend/issues/541)) ([6a2f53e](https://github.com/digdir/dialogporten-frontend/commit/6a2f53e33338fedeeeda0c4ef73570ff3a03c2c3))
* difference behaviour based on if dialog update event was a delete action or just an update event ([7066332](https://github.com/digdir/dialogporten-frontend/commit/706633209c7ab8329c76890848bdb30282aca27e))
* fetching parties with gql function and types generated from stiched schema ([570e764](https://github.com/digdir/dialogporten-frontend/commit/570e764022966e3a082c4d000493435dc380f603))
* graphql endpoint in bff ([524d495](https://github.com/digdir/dialogporten-frontend/commit/524d495aff4c1777c9ffc2de4b1c6643002c3538))
* GraphQL subscription (SSE) and EventSource integration ([78403a5](https://github.com/digdir/dialogporten-frontend/commit/78403a5e7218b94ac706f4cc2cb293142c0b27e7))
* improve login flow for app ([#436](https://github.com/digdir/dialogporten-frontend/issues/436)) ([#452](https://github.com/digdir/dialogporten-frontend/issues/452)) ([d359849](https://github.com/digdir/dialogporten-frontend/commit/d359849b43860d4831e4bc47f4b5428d20a9713e))
* map dialog search dialogs to dialogs + minor styling fixes ([2b0ba5e](https://github.com/digdir/dialogporten-frontend/commit/2b0ba5e75790c39cbb51d303b7e03f4c1f10ad8d))
* move user endpoint to graphql schema with resolver ([a6e488e](https://github.com/digdir/dialogporten-frontend/commit/a6e488e0799a4542ccfc768838d11af8b7ce4c16))
* refactor auth check logic, prevents app to be ninja loaded and improves lout out ux ([61a6fe1](https://github.com/digdir/dialogporten-frontend/commit/61a6fe175a7f9877e30c0d86a14bfb6670f3b2ce))
* Searches now being saved per party. Party dropdown and sidebar reflects actual per party count ([#1017](https://github.com/digdir/dialogporten-frontend/issues/1017)) ([b7b72f7](https://github.com/digdir/dialogporten-frontend/commit/b7b72f7aa50b969b88e18dc02e8c5db8468e7c6c))
* setup Redis in `bff` as storage for sessions ([67ae240](https://github.com/digdir/dialogporten-frontend/commit/67ae240e48f8d9963a81e26e0e66c45e7eaa853d))
* setup vitest for all packages ([a60e9b4](https://github.com/digdir/dialogporten-frontend/commit/a60e9b40b977bce24c61be45dd44af1dbaa26ada))
* stitch Dialogporten-backend-GraphQL and BFF-GraphQL together to one ([6a10124](https://github.com/digdir/dialogporten-frontend/commit/6a10124ab1b0ff29b7da56d12fe7f984901d4628))
* support multiselect filters ([4cd3311](https://github.com/digdir/dialogporten-frontend/commit/4cd3311ae0453a9ffc9cdfc0e7e7d55247a1e885))

Comment on lines +6 to +32
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Enhance feature descriptions and improve organization.

The Features section provides a comprehensive list of improvements. However, it could benefit from better organization and more consistent descriptions. Consider the following suggestions:

  1. Group related features under subheadings for better organization (e.g., "GraphQL Improvements", "Authentication Enhancements", "Performance and Logging").
  2. For major changes, briefly explain the benefit or impact on the system or users.
  3. Ensure consistency in the level of detail provided for each entry.

Here's an example of how you could enhance and group some of the entries:

### Features

#### GraphQL Improvements
* Add graphql-request for fetching data with example ([#543](https://github.com/digdir/dialogporten-frontend/issues/543)) ([668eff9](https://github.com/digdir/dialogporten-frontend/commit/668eff9bff7d521c8032cb538528b8a8fb169ad4))
  - Improves data fetching efficiency and flexibility.
* Implement GraphQL endpoint in BFF ([524d495](https://github.com/digdir/dialogporten-frontend/commit/524d495aff4c1777c9ffc2de4b1c6643002c3538))
* Add GraphQL subscription support via Server-Sent Events (SSE) ([78403a5](https://github.com/digdir/dialogporten-frontend/commit/78403a5e7218b94ac706f4cc2cb293142c0b27e7))
  - Enables real-time updates for improved user experience.
* Stitch Dialogporten-backend-GraphQL and BFF-GraphQL together ([6a10124](https://github.com/digdir/dialogporten-frontend/commit/6a10124ab1b0ff29b7da56d12fe7f984901d4628))
  - Provides a unified GraphQL schema for easier data access.

#### Authentication Enhancements
* Add log out feature ([8a65a21](https://github.com/digdir/dialogporten-frontend/commit/8a65a2165983d87ba560bdb068daa6d950dfa8a3))
* **auth:** Add logout route ([#456](https://github.com/digdir/dialogporten-frontend/issues/456)) ([8a65a21](https://github.com/digdir/dialogporten-frontend/commit/8a65a2165983d87ba560bdb068daa6d950dfa8a3))
* **auth:** Refresh auth tokens when they expire ([#457](https://github.com/digdir/dialogporten-frontend/issues/457)) ([286544d](https://github.com/digdir/dialogporten-frontend/commit/286544d557dcd1751beec54eb52a2391df63af3e))
  - Improves user session management and security.

#### Performance and Logging
* **bff:** Add health checks ([#1099](https://github.com/digdir/dialogporten-frontend/issues/1099)) ([4d0cfde](https://github.com/digdir/dialogporten-frontend/commit/4d0cfdee9675fb0317045e77a0362ce1eaf2c10e))
* **bff:** Use node logger ([#1043](https://github.com/digdir/dialogporten-frontend/issues/1043)) ([d2f359c](https://github.com/digdir/dialogporten-frontend/commit/d2f359c5f24158a480cfb5689f9f03beb68c4ea2))
* Setup Redis in `bff` as storage for sessions ([67ae240](https://github.com/digdir/dialogporten-frontend/commit/67ae240e48f8d9963a81e26e0e66c45e7eaa853d))
  - Enhances session management and improves scalability.

This structure provides more context and makes it easier for readers to understand the impact and importance of each feature.


### Bug Fixes

* actually use the port variable ([d735613](https://github.com/digdir/dialogporten-frontend/commit/d735613b3d0aaa4ffec9a80110adacc211143e61))
* adds token to context since session object is needed in its entirety ([992f94d](https://github.com/digdir/dialogporten-frontend/commit/992f94d77a14fbb4a85c6bc6a57686839ff45ff5))
* another quickfix for making DOckerfile in bff work ([30de172](https://github.com/digdir/dialogporten-frontend/commit/30de1720a35c2cc85240b267dd7be9979b47ebe7))
* await start functions to ensure errors are logged ([#519](https://github.com/digdir/dialogporten-frontend/issues/519)) ([844c66d](https://github.com/digdir/dialogporten-frontend/commit/844c66d533ee4143c908cbdd7c61949dab207467))
* **azure:** add application insights and create container app env ([#333](https://github.com/digdir/dialogporten-frontend/issues/333)) ([13aa6ca](https://github.com/digdir/dialogporten-frontend/commit/13aa6ca097c456f93a5af66fe04873b3591ea740))
* **bff:** add the correct graphql endpoint ([#611](https://github.com/digdir/dialogporten-frontend/issues/611)) ([5780856](https://github.com/digdir/dialogporten-frontend/commit/57808562a3f706839c598373a278b83b46849d7f))
* **bff:** avoid running app on migration ([#361](https://github.com/digdir/dialogporten-frontend/issues/361)) ([038ca12](https://github.com/digdir/dialogporten-frontend/commit/038ca12b7ef900edd41994564da1ff617d1fb051))
* **bff:** bff migrations ([#555](https://github.com/digdir/dialogporten-frontend/issues/555)) ([32b8075](https://github.com/digdir/dialogporten-frontend/commit/32b80756f392cb7857d8023456f61c741b70e879))
* **bff:** convert to opentelemetry ([#1082](https://github.com/digdir/dialogporten-frontend/issues/1082)) ([9ef3427](https://github.com/digdir/dialogporten-frontend/commit/9ef34278884364bb18fc94e4819cd6d306961dc5))
* **bff:** enable application insights ([#1015](https://github.com/digdir/dialogporten-frontend/issues/1015)) ([c8fd06d](https://github.com/digdir/dialogporten-frontend/commit/c8fd06d9fdd92376d5824a2eb9a76dc85a7f7814))
* **bff:** ensure instrumentation is initialized before starting the app ([#1118](https://github.com/digdir/dialogporten-frontend/issues/1118)) ([4c0f687](https://github.com/digdir/dialogporten-frontend/commit/4c0f687e84f6cf6132112c3b6257bc15306b62c6))
* **bff:** fix migration job ([#358](https://github.com/digdir/dialogporten-frontend/issues/358)) ([9e9f478](https://github.com/digdir/dialogporten-frontend/commit/9e9f478cef83d7e35dbf97a23f3179322704f35f))
* **bff:** start script ([#556](https://github.com/digdir/dialogporten-frontend/issues/556)) ([60aefc5](https://github.com/digdir/dialogporten-frontend/commit/60aefc5845c9335c7ff34e3be23fe54cb167f5af))
* **bff:** use correct command in dockerfile ([#380](https://github.com/digdir/dialogporten-frontend/issues/380)) ([33bdd7b](https://github.com/digdir/dialogporten-frontend/commit/33bdd7bd25a1037f946a8d849b934b6309e4357b))
* change refresh auth token flow ([#1005](https://github.com/digdir/dialogporten-frontend/issues/1005)) ([c9b5bf6](https://github.com/digdir/dialogporten-frontend/commit/c9b5bf699d3fe7dc1a697c090bf2842912bdff5f))
* clean up bff and login ([f96eab1](https://github.com/digdir/dialogporten-frontend/commit/f96eab1e1b8f298433e673a63bee44f64bff8e27))
* dialogporten.noconsent scope ([43846f9](https://github.com/digdir/dialogporten-frontend/commit/43846f915acaff18254a05f21a05bf9ecc2b00a1))
* ensure tls in Redis connection string and fix health checks ([#523](https://github.com/digdir/dialogporten-frontend/issues/523)) ([27ebed0](https://github.com/digdir/dialogporten-frontend/commit/27ebed0dbcf931a069ed4d6e7d7556812a8fad53))
* fixes logout not working ([#517](https://github.com/digdir/dialogporten-frontend/issues/517)) ([7048ee9](https://github.com/digdir/dialogporten-frontend/commit/7048ee9d8896ca36a1b52ad5c1470a2fb1a59f16))
* quickfix for broken docker command ([316367d](https://github.com/digdir/dialogporten-frontend/commit/316367de4308b1dd0444b0bd8388f67140d18a16))
* Refactoring bff and removing old frontend ([#375](https://github.com/digdir/dialogporten-frontend/issues/375)) ([05d904c](https://github.com/digdir/dialogporten-frontend/commit/05d904c100e1dd0dbb3a3af94757e11f3b4a08b5))
* remove app insights native sdk ([62b12a4](https://github.com/digdir/dialogporten-frontend/commit/62b12a45760ddeb12fd7d9fc942aef0874ebdfd9))
* remove console line ([2a558e6](https://github.com/digdir/dialogporten-frontend/commit/2a558e66a9929d42b333f77832ae06d02dc5fb38))
* some BFF rafactoring ([bd729f8](https://github.com/digdir/dialogporten-frontend/commit/bd729f81db90a086092850b8337bf3432d2debd8))
Comment on lines +34 to +59
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Improve organization and clarity in the Bug Fixes section.

The Bug Fixes section covers a wide range of improvements, which is great for overall stability. However, to make this section more informative and useful, consider the following suggestions:

  1. Group related fixes under subheadings (e.g., "Deployment", "Authentication", "Performance").
  2. For critical or user-facing fixes, briefly explain the impact of the bug and how the fix improves the system.
  3. For technical fixes, provide a bit more context about why the change was necessary.

Here's an example of how you could enhance and group some of the entries:

### Bug Fixes

#### Deployment and Infrastructure
* **azure:** Add application insights and create container app env ([#333](https://github.com/digdir/dialogporten-frontend/issues/333)) ([13aa6ca](https://github.com/digdir/dialogporten-frontend/commit/13aa6ca097c456f93a5af66fe04873b3591ea740))
  - Improves monitoring and deployment capabilities in Azure environment.
* Fix Docker-related issues:
  - Use correct command in Dockerfile ([#380](https://github.com/digdir/dialogporten-frontend/issues/380)) ([33bdd7b](https://github.com/digdir/dialogporten-frontend/commit/33bdd7bd25a1037f946a8d849b934b6309e4357b))
  - Quick fix for broken Docker command ([316367d](https://github.com/digdir/dialogporten-frontend/commit/316367de4308b1dd0444b0bd8388f67140d18a16))
  - Ensure Dockerfile in BFF works correctly ([30de172](https://github.com/digdir/dialogporten-frontend/commit/30de1720a35c2cc85240b267dd7be9979b47ebe7))

#### Authentication and Session Management
* Fix logout functionality ([#517](https://github.com/digdir/dialogporten-frontend/issues/517)) ([7048ee9](https://github.com/digdir/dialogporten-frontend/commit/7048ee9d8896ca36a1b52ad5c1470a2fb1a59f16))
  - Resolves issues where users were unable to log out properly.
* Change refresh auth token flow ([#1005](https://github.com/digdir/dialogporten-frontend/issues/1005)) ([c9b5bf6](https://github.com/digdir/dialogporten-frontend/commit/c9b5bf699d3fe7c1a697c090bf2842912bdff5f))
  - Improves reliability of authentication token refresh process.

#### Performance and Logging
* **bff:** Convert to OpenTelemetry ([#1082](https://github.com/digdir/dialogporten-frontend/issues/1082)) ([9ef3427](https://github.com/digdir/dialogporten-frontend/commit/9ef34278884364bb18fc94e4819cd6d306961dc5))
  - Enhances observability and performance monitoring capabilities.
* **bff:** Enable application insights ([#1015](https://github.com/digdir/dialogporten-frontend/issues/1015)) ([c8fd06d](https://github.com/digdir/dialogporten-frontend/commit/c8fd06d9fdd92376d5824a2eb9a76dc85a7f7814))
  - Improves application monitoring and diagnostics.

This structure provides more context and makes it easier for readers to understand the impact and importance of each fix. It also helps developers and stakeholders quickly identify the areas of improvement in the system.

Comment on lines +1 to +59
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Enhance overall changelog structure and content for improved clarity.

The changelog for version 1.1.0 of the BFF package provides a comprehensive list of features and bug fixes, which is commendable. However, to further improve its readability and usefulness, consider implementing the following recommendations:

  1. Group related features and bug fixes under descriptive subheadings.
  2. Provide brief explanations of the impact or benefit for major changes.
  3. Ensure consistency in the level of detail provided for each entry.
  4. Remove extra blank lines to maintain consistent formatting.

By implementing these changes, you'll create a more structured and informative changelog that:

  • Allows readers to quickly identify areas of improvement.
  • Provides context for the changes, making it easier to understand their significance.
  • Improves overall readability and organization.

These enhancements will make the changelog more valuable for both developers and stakeholders, providing a clearer picture of the improvements and fixes in this release.

Tools
Markdownlint

5-5: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)

33-33: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)

2 changes: 1 addition & 1 deletion packages/bff/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "bff",
"version": "1.0.0",
"version": "1.1.0",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tip

Codebase Verification

Changelog Missing for Version 1.1.0

The changelog does not contain an entry for version 1.1.0. Please update the changelog to include the details of this version.

Analysis chain

LGTM: Version bump looks good.

The version update from 1.0.0 to 1.1.0 is correct and follows semantic versioning practices. This minor version increment suggests new features or improvements have been added in a backward-compatible manner.

To ensure the version bump is properly documented, please verify that the changelog has been updated to reflect the changes in this new version. You can run the following script to check the changelog:

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the changelog has been updated for version 1.1.0

# Test: Search for version 1.1.0 in the changelog
changelog_file=$(fd -t f -e md -e MD -i changelog)
if [ -n "$changelog_file" ]; then
  if grep -q "1.1.0" "$changelog_file"; then
    echo "Changelog found and contains version 1.1.0"
  else
    echo "Changelog found but does not contain version 1.1.0"
  fi
else
  echo "No changelog file found"
fi

Length of output: 935

"main": "src/index.ts",
"private": true,
"scripts": {
Expand Down
22 changes: 22 additions & 0 deletions packages/docs/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Changelog

## [1.1.0](https://github.com/digdir/dialogporten-frontend/compare/docs-v1.0.0...docs-v1.1.0) (2024-09-24)


Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove extra blank lines for consistency.

There are instances of multiple consecutive blank lines in the document (after lines 4 and 16). To improve consistency and adhere to markdown best practices, consider removing the extra blank lines, leaving only one blank line between sections.

Also applies to: 17-17

Tools
Markdownlint

5-5: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)

### Features

* add checking for missing i18n keys ([45cef62](https://github.com/digdir/dialogporten-frontend/commit/45cef62a777c60678aff0d5637fb1afa9d913547))
* add husky and pre-commit hook with lint-staged ([#247](https://github.com/digdir/dialogporten-frontend/issues/247)) ([#259](https://github.com/digdir/dialogporten-frontend/issues/259)) ([0de2661](https://github.com/digdir/dialogporten-frontend/commit/0de266166269d7aa75a986cbab8d5fb73eae63ba))
* add xs size for profile button + small fixes in header ([4aee6df](https://github.com/digdir/dialogporten-frontend/commit/4aee6df363b10a0d553a4ffc0ea9ea018ed8b88b))
* **azure:** add ssh jumper ([#993](https://github.com/digdir/dialogporten-frontend/issues/993)) ([a6bc0e6](https://github.com/digdir/dialogporten-frontend/commit/a6bc0e69afcfc2a99ef68bda0b7b318528f03e54))
* implement fiterBar in app ([8ee871d](https://github.com/digdir/dialogporten-frontend/commit/8ee871d75f3784a4792f4a702f53ec5843bcc68f))
* stitch Dialogporten-backend-GraphQL and BFF-GraphQL together to one ([6a10124](https://github.com/digdir/dialogporten-frontend/commit/6a10124ab1b0ff29b7da56d12fe7f984901d4628))
* support multi level and date ([22c4589](https://github.com/digdir/dialogporten-frontend/commit/22c4589f689991044b9b8b2303c924a558d99a59))
* TLDraw plugin for Docusaurus ([df0faee](https://github.com/digdir/dialogporten-frontend/commit/df0faee7215a1f06ecbe601511e016a79acb578c))
Comment on lines +6 to +15
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider enhancing feature descriptions for clarity and consistency.

While the Features section provides good information, consider the following improvements:

  1. Ensure consistent capitalization at the start of each entry.
  2. Provide brief explanations for technical terms or abbreviations (e.g., i18n, BFF).
  3. Add more context to entries like "implement fiterBar in app" to clarify the purpose and benefit of the feature.

These changes would make the changelog more accessible to all readers, regardless of their familiarity with the project.



### Bug Fixes

* attempt issue not respecting BASEURL env variable by updating ([3c4dba8](https://github.com/digdir/dialogporten-frontend/commit/3c4dba84a48d64e6614194cfcb43957fb84a309f))
* **bff:** enable application insights ([#1015](https://github.com/digdir/dialogporten-frontend/issues/1015)) ([c8fd06d](https://github.com/digdir/dialogporten-frontend/commit/c8fd06d9fdd92376d5824a2eb9a76dc85a7f7814))
* testing again, changing default baseurl ([58b7c81](https://github.com/digdir/dialogporten-frontend/commit/58b7c81db4c0d77762f35c65425e66b53005888f))
Comment on lines +18 to +22
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix typo and consider clarifying the BASEURL-related fixes.

  1. In the first bug fix entry, there seems to be a typo or incomplete sentence: "attempt issue not respecting BASEURL env variable by updating". Consider rephrasing for clarity.

  2. There are two entries related to BASEURL. It might be helpful to combine these or provide more context on why two separate changes were needed.

Addressing these points would improve the clarity of the bug fix section.

14 changes: 11 additions & 3 deletions packages/docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "docs",
"version": "1.0.0",
"version": "1.1.0",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
Expand Down Expand Up @@ -38,7 +38,15 @@
"typescript": "~5.5.4"
},
"browserslist": {
"production": [">0.5%", "not dead", "not op_mini all"],
"development": ["last 3 chrome version", "last 3 firefox version", "last 5 safari version"]
"production": [
">0.5%",
"not dead",
"not op_mini all"
],
"development": [
"last 3 chrome version",
"last 3 firefox version",
"last 5 safari version"
]
Comment on lines +41 to +50
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick (assertive)

Browserslist formatting improvement is good.

The reformatting of the browserslist section enhances readability without changing functionality. This is a positive change for maintainability.

For consistency, consider adding a trailing comma after the last item in each array. This can make future additions easier and keeps the diff cleaner. Here's a suggested minor improvement:

 "browserslist": {
   "production": [
     ">0.5%",
     "not dead",
-    "not op_mini all"
+    "not op_mini all",
   ],
   "development": [
     "last 3 chrome version",
     "last 3 firefox version",
-    "last 5 safari version"
+    "last 5 safari version",
   ]
 }
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
"production": [
">0.5%",
"not dead",
"not op_mini all"
],
"development": [
"last 3 chrome version",
"last 3 firefox version",
"last 5 safari version"
]
"production": [
">0.5%",
"not dead",
"not op_mini all",
],
"development": [
"last 3 chrome version",
"last 3 firefox version",
"last 5 safari version",
]

}
}
13 changes: 13 additions & 0 deletions packages/docusaurus-tldraw-plugin/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Changelog

## [1.1.0](https://github.com/digdir/dialogporten-frontend/compare/docusaurus-tldraw-plugin-v1.0.0...docusaurus-tldraw-plugin-v1.1.0) (2024-09-24)


### Features

* TLDraw plugin for Docusaurus ([df0faee](https://github.com/digdir/dialogporten-frontend/commit/df0faee7215a1f06ecbe601511e016a79acb578c))
Comment on lines +5 to +8
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM: Feature clearly described. Consider removing extra blank line.

The feature description is concise and clear, with a proper commit reference. However, there's an extra blank line before the "Features" section that could be removed for consistency.

Consider applying this change:

 ## [1.1.0](https://github.com/digdir/dialogporten-frontend/compare/docusaurus-tldraw-plugin-v1.0.0...docusaurus-tldraw-plugin-v1.1.0) (2024-09-23)

-
 ### Features

 * TLDraw plugin for Docusaurus ([df0faee](https://github.com/digdir/dialogporten-frontend/commit/df0faee7215a1f06ecbe601511e016a79acb578c))
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Features
* TLDraw plugin for Docusaurus ([df0faee](https://github.com/digdir/dialogporten-frontend/commit/df0faee7215a1f06ecbe601511e016a79acb578c))
## [1.1.0](https://github.com/digdir/dialogporten-frontend/compare/docusaurus-tldraw-plugin-v1.0.0...docusaurus-tldraw-plugin-v1.1.0) (2024-09-23)
### Features
* TLDraw plugin for Docusaurus ([df0faee](https://github.com/digdir/dialogporten-frontend/commit/df0faee7215a1f06ecbe601511e016a79acb578c))
Tools
Markdownlint

5-5: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)



### Bug Fixes

* **deps:** update dependency tldraw to v2.4.4 ([f5b6712](https://github.com/digdir/dialogporten-frontend/commit/f5b6712b225bbd02e16d452c22ed4d86909d0da8))
Comment on lines +9 to +13
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM: Bug fix clearly described. Consider removing extra blank line.

The bug fix description follows the conventional commit format and includes a proper commit reference. However, there's an extra blank line before the "Bug Fixes" section that could be removed for consistency.

Consider applying this change:

 * TLDraw plugin for Docusaurus ([df0faee](https://github.com/digdir/dialogporten-frontend/commit/df0faee7215a1f06ecbe601511e016a79acb578c))

-
 ### Bug Fixes

 * **deps:** update dependency tldraw to v2.4.4 ([f5b6712](https://github.com/digdir/dialogporten-frontend/commit/f5b6712b225bbd02e16d452c22ed4d86909d0da8))
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Bug Fixes
* **deps:** update dependency tldraw to v2.4.4 ([f5b6712](https://github.com/digdir/dialogporten-frontend/commit/f5b6712b225bbd02e16d452c22ed4d86909d0da8))
### Bug Fixes
* **deps:** update dependency tldraw to v2.4.4 ([f5b6712](https://github.com/digdir/dialogporten-frontend/commit/f5b6712b225bbd02e16d452c22ed4d86909d0da8))
Tools
Markdownlint

10-10: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)

8 changes: 6 additions & 2 deletions packages/docusaurus-tldraw-plugin/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
{
"name": "docusaurus-tldraw-plugin",
"version": "1.0.0",
"version": "1.1.0",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Version bump to 1.1.0 has inconsistencies.

  • The CHANGELOG.md does not include an entry for version 1.1.0.
  • A git tag for docusaurus-tldraw-plugin-v1.1.0 is missing.

Please update the CHANGELOG.md with the new version details and create the corresponding git tag to ensure proper versioning.

Analysis chain

Version bump to 1.1.0 noted.

The package version has been updated from 1.0.0 to 1.1.0, indicating a minor release with new features or non-breaking changes. Ensure that this version bump aligns with the changes made in this release and follows semantic versioning principles.

To verify the consistency of this version bump across the project, run the following script:

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for version consistency in package.json and changelog

# Test 1: Check if the version in package.json matches the latest entry in CHANGELOG.md
version=$(jq -r .version packages/docusaurus-tldraw-plugin/package.json)
echo "Version in package.json: $version"
changelog_version=$(head -n 1 packages/docusaurus-tldraw-plugin/CHANGELOG.md | grep -oP '\d+\.\d+\.\d+')
echo "Latest version in CHANGELOG.md: $changelog_version"

# Test 2: Check if there's a corresponding entry in the root .release-please-manifest.json
manifest_version=$(jq -r '."packages/docusaurus-tldraw-plugin"' .release-please-manifest.json)
echo "Version in .release-please-manifest.json: $manifest_version"

# Test 3: Check if there's a git tag for this version
git_tag=$(git tag -l "docusaurus-tldraw-plugin-v$version")
echo "Git tag for this version: $git_tag"

Length of output: 663

"description": "Docusaurus plugin for embedding tldraw drawings in docs",
"main": "src/index.js",
"scripts": {
"test": ""
},
"keywords": ["docusaurus", "tldraw", "plugin"],
"keywords": [
"docusaurus",
"tldraw",
"plugin"
],
Comment on lines +9 to +13
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Improved formatting for keywords array.

The multi-line format for the keywords array enhances readability. While this change doesn't affect functionality, it's a good practice for maintaining clean and easily scannable JSON files.

Consider adding a trailing comma after the last item in the array for consistency and easier future additions:

 "keywords": [
   "docusaurus",
   "tldraw",
-  "plugin"
+  "plugin",
 ],
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
"keywords": [
"docusaurus",
"tldraw",
"plugin"
],
"keywords": [
"docusaurus",
"tldraw",
"plugin",
],

"author": "",
"license": "MIT",
"dependencies": {
Expand Down
Loading
Loading