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.

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

fix(core/windows-doc-generation): fix for component-doc generation #1070

Merged
merged 2 commits into from
Feb 8, 2024

Conversation

matthiashader
Copy link
Collaborator

@matthiashader matthiashader commented Feb 7, 2024

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Build (yarn build) was run locally and any changes were pushed
  • Unit tests (yarn test) were run locally and passed
  • Visual Regression Tests (yarn visual-regression) were run locally and passed
  • Linting (npm lint) was run locally and passed

Pull request type

Please check the type of change your PR introduces:

  • Bug fix
  • Feature
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

When building on Windows, the relative paths are formatted in Windows style and getting escaped (e.g., \src\components\action-card.tsx), potentially causing issues in the pipeline due to inconsistent path formats. To ensure seamless behavior, a small adaptation has been made to transform paths to Unix-style, even when building on Windows.
Tested on Windows 10 and Fedora 38.

GitHub Issue Number: N/A

What is the new behavior?

All paths are getting formated in a unix style way

Does this introduce a breaking change?

  • Yes
  • No

Testing

Other information

@nuke-ellington nuke-ellington added this to the 2.1.0 milestone Feb 8, 2024
@nuke-ellington nuke-ellington added the pull request affects patch version The pull request affects only patch version label Feb 8, 2024
@nuke-ellington nuke-ellington merged commit 39d88a6 into main Feb 8, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pull request affects patch version The pull request affects only patch version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants