Skip to content

Conversation

@iobuhov
Copy link
Collaborator

@iobuhov iobuhov commented Nov 10, 2022

Description

If you run pnpm run changelog and choose charts-web this command will fail. Right now we have two changelog formats: widget and module. Widget format is simple and don't require extra effort to handle and maintain. Module format is bit complex and actually it's better to call this format as "composed changelog" as it tries to get all records from it's children (eg. in data-widgets and charts-web). So, pnpm run changelog tries to parse changelog with widget format, if it fails, then it tries to parse changelog with module format. The problem is that charts-web, is a widget, which uses module format for changelogs... yeah, I know. So, to not make things even more complex we now use generic function to parse package metadata, so we don't care what format is used for package.

Pull request checklist

  • All new and existing tests passed
  • I run lint command locally and it doesn’t give errors
  • PR title properly formatted [XX-000]: description
  • Added record to packages' CHANGELOG.md
  • Bumped package version in package.json and package.xml
  • Added a link to related project PRs (atlas, pluggable-widgets-tools, testProject, etc.) (optional)
  • Created docs PR to mendix/docs and added a link (optional)

Pull request type

  • No code changes (changes to documentation, CI, metadata, etc)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Test related change (New E2E test, test automation, etc.)

What should be covered while testing?

  • pnpm run changelog command for charts-web pacakge

@iobuhov iobuhov requested a review from a team as a code owner November 10, 2022 12:15
@iobuhov iobuhov merged commit ca54a01 into main Nov 11, 2022
@iobuhov iobuhov deleted the fix-changelog-command branch November 11, 2022 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants