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

Chore: Remove generated PUML image and exclude it from .gitignore #2497

Merged
merged 3 commits into from
Apr 6, 2024

Conversation

kaixin-hc
Copy link
Contributor

@kaixin-hc kaixin-hc commented Apr 4, 2024

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • DevOps
  • Improve developer experience
  • Others, please explain:

Overview of changes:
Add the generated PNG to the gitignore as described in this part of the dev guide as it was erroneously committed.

Anything you'd like to highlight/discuss:

Testing instructions:

Proposed commit message: (wrap lines at 72 characters)

Chore: Remove generated PUML image and exclude it from .gitignore

Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

Reviewer checklist:

Indicate the SEMVER impact of the PR:

  • Major (when you make incompatible API changes)
  • Minor (when you add functionality in a backward compatible manner)
  • Patch (when you make backward compatible bug fixes)

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

  • To be included in the release note for any feature that is made obsolete/breaking
    NIL

Give a brief explanation note about:

  • what was the old feature that was made obsolete
  • any replacement feature (if any), and
  • how the author should modify his website to migrate from the old feature to the replacement feature (if possible).

Copy link
Contributor

@yucheng11122017 yucheng11122017 left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for the work

@kaixin-hc
Copy link
Contributor Author

Thanks for your review!

After investigation, tests are failing due to a mismatch between expected files and generated files. We can refer to this PR. This is because in packages/cli/test/functional/testSites.js, a list of plantuml files that are expected in test-site are saved, and in the compare function the existence of these ignored files is checked for before all ignored files are filtered out and compared.

However, in this line compare(siteName, 'expected', '_site', siteName === 'test_site' ? plantumlGeneratedFiles : []); essentially plantuml files are only checked for in test_site.

I'll make a separate issue about fixing this, and we can merge this chore once this section has been improved.

Copy link

codecov bot commented Apr 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 51.14%. Comparing base (003822f) to head (54c8824).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2497   +/-   ##
=======================================
  Coverage   51.14%   51.14%           
=======================================
  Files         124      124           
  Lines        5359     5359           
  Branches     1152     1152           
=======================================
  Hits         2741     2741           
  Misses       2328     2328           
  Partials      290      290           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kaixin-hc kaixin-hc merged commit 2d6ca01 into MarkBind:master Apr 6, 2024
9 checks passed
@github-actions github-actions bot added the r.Patch Version resolver: increment by 0.0.1 label Apr 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
r.Patch Version resolver: increment by 0.0.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants