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

Jump to bottom

Reduces VSIX size ignoring docs media #3878

Merged
merged 2 commits into from
Dec 18, 2024
Merged

Reduces VSIX size ignoring docs media #3878

merged 2 commits into from
Dec 18, 2024

Conversation

nzaytsev
Copy link
Contributor

Description

Checklist

  • I have followed the guidelines in the Contributing document
  • My changes follow the coding style of this project
  • My changes build without any errors or warnings
  • My changes have been formatted and linted
  • My changes include any required corresponding changes to the documentation (including CHANGELOG.md and README.md)
  • My changes have been rebased and squashed to the minimal number (typically 1) of relevant commits
  • My changes have a descriptive commit message with a short title, including a Fixes $XXX - or Closes #XXX - prefix to auto-close the issue that your PR addresses

@nzaytsev nzaytsev linked an issue Dec 17, 2024 that may be closed by this pull request
Remove unused media assets #3860
Closed
@nzaytsev nzaytsev requested review from eamodio and d13 December 17, 2024 08:57
@nzaytsev nzaytsev force-pushed the debt/3860-remove-unused-media-assets branch from 1e0f8b6 to 0b981ce Compare December 17, 2024 08:59
eamodio
eamodio requested changes Dec 17, 2024
View reviewed changes
Copy link
Member

@eamodio eamodio left a comment

Choose a reason for hiding this comment

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

Can't merge as is -- need to go through the images and see if they are used or not and if not should be removed.

.vscodeignore
@@ -7,8 +7,7 @@
.yarn/**
docs/**
emoji/**
images/docs/sponsors/**
images/docs/gitlens-preview.gif
images/docs
Copy link
Member

Choose a reason for hiding this comment

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

We can't exclude all the docs images, because any images referenced in the README (which is the extension manifest page), walkthroughs, etc, need to be available locally.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

any images referenced in the README

They are referenced to raw.githubusercontent.com, for example:

vscode-gitlens/README.md

Line 14 in 0f6f6ac

<a title="Watch the GitLens Getting Started video" href="https://www.youtube.com/watch?v=UQPb73Zz9qk"><img src="https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/get-started-video.png" alt="Watch the GitLens Getting Started video" /></a>

If I open readme, I see that it's referenced to cloud storage, not to locally bundled images

Screenshot 2024-12-18 at 10 27 12

There is no place where the image from this dir is used locally

walkthroughs, etc

walkthroughs assets are placed in another directory, I didn't touch it. But it can also be moved to cloud storage and removed from the bundle

Copy link
Member

Choose a reason for hiding this comment

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

Ah -- I forgot that the VS Code marketplace changed to require all README links to be https. So it looks like you are correct those images don't need to be bundled.

As for the walkthroughs, if we use https links then the walkthroughs won't work offline, which is not ideal. So we should leave them alone.

.vscodeignore
@@ -46,3 +45,4 @@ tsconfig*.json
tsconfig*.tsbuildinfo
webpack.config*.mjs
yarn.lock
.wdio-vscode-service
Copy link
Member

Choose a reason for hiding this comment

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

This doesn't hurt anything, but this already isn't getting bundled today.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

but this already isn't getting bundled today

I see that this folder is not git ignored, and I see it in the bundled zip
Screenshot 2024-12-18 at 10 22 00

This doesn't hurt anything

Maybe it's truth in the environment that is isolated from tests running, but I see that it may affect the final size

Screenshot 2024-12-18 at 10 23 12

Copy link
Member

Choose a reason for hiding this comment

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

Not sure what is creating that folder -- we aren't using webdriver, is that just an old folder you have? When I said it won't be bundled, I meant via CI (your local folder can have all kinds of stuff that would get "accidentally" bundled)

@nzaytsev nzaytsev requested a review from eamodio December 18, 2024 03:29
@eamodio eamodio merged commit 415d6ac into main Dec 18, 2024
3 checks passed
newkdr added a commit to newkdr/vscode-gitlens that referenced this pull request Dec 18, 2024
@newkdr
[Snyk] Upgrade billboard.js from 3.14.0 to 3.14.2 (#8)
93e3ef4 
![snyk-top-banner](https://github.com/andygongea/OWASP-Benchmark/assets/818805/c518c423-16fe-447e-b67f-ad5a49b5d123)


<h3>Snyk has created this PR to upgrade billboard.js from 3.14.0 to
3.14.2.</h3>

:information_source: Keep your dependencies up-to-date. This makes it
easier to fix existing vulnerabilities and to more quickly identify and
fix newly disclosed vulnerabilities when they affect your project.

<hr/>


- The recommended version is **2 versions** ahead of your current
version.

- The recommended version was released on **21 days ago**.



<details>
<summary><b>Release notes</b></summary>
<br/>
  <details>
    <summary>Package name: <b>billboard.js</b></summary>
    <ul>
      <li>
<b>3.14.2</b> - <a
href="https://github.com/naver/billboard.js/releases/tag/3.14.2">2024-11-26</a></br><h2><a
href="https://github.com/naver/billboard.js/compare/3.14.1...3.14.2">3.14.2</a>
(2024-11-26)</h2>
<h3>Bug Fixes</h3>
<ul>
<li><strong>axis:</strong> Fix x axis extent to work (<a
href="https://github.com/naver/billboard.js/commit/4d738348ee5c189274d277ce07bd31d626de303d">4d73834</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3768"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3768/hovercard">gitkraken#3768</a></li>
<li><strong>tooltip:</strong> Fix tooltip position on viewBox resizing
(<a
href="https://github.com/naver/billboard.js/commit/582feb46500a2eaf337a83f225dcebcc4d9317e9">582feb4</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3917"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3917/hovercard">gitkraken#3917</a></li>
</ul>
      </li>
      <li>
<b>3.14.1</b> - <a
href="https://github.com/naver/billboard.js/releases/tag/3.14.1">2024-11-18</a></br><h2><a
href="https://github.com/naver/billboard.js/compare/3.14.0...3.14.1">3.14.1</a>
(2024-11-18)</h2>
<h3>Bug Fixes</h3>
<ul>
<li><strong>point:</strong> fix data.onclick working with sensitivity
function (<a
href="https://github.com/naver/billboard.js/commit/587d71e9b413d5abd2265a3fb13c3c09914fca80">587d71e</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3912"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3912/hovercard">gitkraken#3912</a></li>
<li><strong>tooltip:</strong> Hide tooltip on redraw when unexpected
error (<a
href="https://github.com/naver/billboard.js/commit/35406406962c89bac0503800771d96ba2f47f56d">3540640</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3909"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3909/hovercard">gitkraken#3909</a>
<a href="https://github.com/naver/billboard.js/issues/3910"
data-hovercard-type="pull_request"
data-hovercard-url="/naver/billboard.js/pull/3910/hovercard">gitkraken#3910</a></li>
</ul>
      </li>
      <li>
<b>3.14.0</b> - <a
href="https://github.com/naver/billboard.js/releases/tag/3.14.0">2024-10-25</a></br><h1><a
href="https://github.com/naver/billboard.js/compare/3.13.0...3.14.0">3.14.0</a>
(2024-10-25)</h1>
<p>The detailed new feature description can be found at:</p>
<blockquote>
<p><a
href="https://netil.medium.com/billboard-js-3-14-release-viewbox-resizing-e1cb90ee0697"
rel="nofollow">billboard.js 3.14 release: viewBox resizing!</a> (<a
href="https://dev.to/netil/billboardjs-314-release-viewbox-resizing-p6e"
rel="nofollow">dev.to link</a>)</p>
</blockquote>
<h3>Bug Fixes</h3>
<ul>
<li><strong>axis:</strong> fix error when showing tick only (<a
href="https://github.com/naver/billboard.js/commit/705947f635807e359c5c2f869a7d906e2315a01a">705947f</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3881"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3881/hovercard">gitkraken#3881</a></li>
<li><strong>bar:</strong> fix representation of radius for small data
(<a
href="https://github.com/naver/billboard.js/commit/91b5dca91a86779b0c808e3498d85dcb93ab5f0e">91b5dca</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3903"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3903/hovercard">gitkraken#3903</a></li>
<li><strong>event:</strong> Fix interaction with viewBox (<a
href="https://github.com/naver/billboard.js/commit/243bf3cf10a7d3b4b0f668240168e4b2d9ba1eba">243bf3c</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3414"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3414/hovercard">gitkraken#3414</a></li>
<li><strong>input:</strong> Fix touch/mouse input detection (<a
href="https://github.com/naver/billboard.js/commit/3d4392ac51dca1947c6380329f7c6a6e0b3a497a">3d4392a</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3854"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3854/hovercard">#3854</a></li>
<li><strong>point:</strong> fix sensitivity error when blank area is
clicked (<a
href="https://github.com/naver/billboard.js/commit/00607861a96826b2e1c9fec37159065680ff278e">0060786</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3900"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3900/hovercard">#3900</a></li>
<li><strong>scale:</strong> Fix non-shape's element positioned
accurately (<a
href="https://github.com/naver/billboard.js/commit/216141bd6a415752fbb31ba3016188b20401f5b0">216141b</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3907"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3907/hovercard">#3907</a></li>
<li><strong>size:</strong> Fix legend overflows with padding fit mode
(<a
href="https://github.com/naver/billboard.js/commit/8357d1161fa132a6d788c1349dee1f7e99eedf39">8357d11</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3872"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3872/hovercard">gitkraken#3872</a></li>
<li><strong>zoom:</strong> Fix unzoom after dynamic data load (<a
href="https://github.com/naver/billboard.js/commit/385907e5cbab1af52b63f9a2987a302d479fe332">385907e</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3878"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3878/hovercard">gitkraken#3878</a></li>
<li><strong>zoom:</strong> Prevent error for out of range (<a
href="https://github.com/naver/billboard.js/commit/6f69e970bd31fdd9d353854c54437c2a9c95e269">6f69e97</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3895"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3895/hovercard">gitkraken#3895</a></li>
</ul>
<h3>Features</h3>
<ul>
<li><strong>axis:</strong> Intent to ship axis.evalTextSize (<a
href="https://github.com/naver/billboard.js/commit/87048e9258d521ffb4da7b98a167e184fe3489a3">87048e9</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3889"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3889/hovercard">gitkraken#3889</a></li>
<li><strong>interaction:</strong> Intent to ship interaction.onout (<a
href="https://github.com/naver/billboard.js/commit/9c668e688624e0003d6dca6ea00fcf79a3f1b782">9c668e6</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3887"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3887/hovercard">gitkraken#3887</a></li>
<li><strong>legend:</strong> Pass visibility state to legend item's
event callback (<a
href="https://github.com/naver/billboard.js/commit/ba71911b7c4b47b95f0b1e2bf8f12138d5b31cb1">ba71911</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3897"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3897/hovercard">gitkraken#3897</a></li>
<li><strong>render:</strong> Add forced init option on lazy rendering
(<a
href="https://github.com/naver/billboard.js/commit/218ce4608dd7da7a5288bce1c6f95d71d8aa9c5f">218ce46</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3106"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3106/hovercard">gitkraken#3106</a></li>
<li><strong>resize:</strong> Intent to ship resize.auto='viewBox' (<a
href="https://github.com/naver/billboard.js/commit/db213873e2959b7c24c44f1330ec86af801406e8">db21387</a>),
closes <a
href="https://github.com/naver/billboard.js/issues/3893"
data-hovercard-type="issue"
data-hovercard-url="/naver/billboard.js/issues/3893/hovercard">gitkraken#3893</a></li>
</ul>
      </li>
    </ul>
from <a
href="https://github.com/naver/billboard.js/releases">billboard.js
GitHub release notes</a>
  </details>
</details>

---

> [!IMPORTANT]
>
> - Check the changes in this PR to ensure they won't cause issues with
your project.
> - This PR was automatically created by Snyk using the credentials of a
real user.

---

**Note:** _You are seeing this because you or someone else with access
to this repository has authorized Snyk to open upgrade PRs._

**For more information:** <img
src="https://api.segment.io/v1/pixel/track?data=eyJ3cml0ZUtleSI6InJyWmxZcEdHY2RyTHZsb0lYd0dUcVg4WkFRTnNCOUEwIiwiYW5vbnltb3VzSWQiOiJkY2EwZTViMC1mNjdhLTQwZDMtODQwOS05ZDMxYWU5ZDY4YzkiLCJldmVudCI6IlBSIHZpZXdlZCIsInByb3BlcnRpZXMiOnsicHJJZCI6ImRjYTBlNWIwLWY2N2EtNDBkMy04NDA5LTlkMzFhZTlkNjhjOSJ9fQ=="
width="0" height="0"/>

> - 🧐 [View latest project
report](https://app.snyk.io/org/newkdr/project/12a8a5f5-3e19-438c-8280-eb8f4ee06d17?utm_source&#x3D;github&amp;utm_medium&#x3D;referral&amp;page&#x3D;upgrade-pr)
> - 📜 [Customise PR
templates](https://docs.snyk.io/scan-using-snyk/pull-requests/snyk-fix-pull-or-merge-requests/customize-pr-templates?utm_source=&utm_content=fix-pr-template)
> - 🛠 [Adjust upgrade PR
settings](https://app.snyk.io/org/newkdr/project/12a8a5f5-3e19-438c-8280-eb8f4ee06d17/settings/integration?utm_source&#x3D;github&amp;utm_medium&#x3D;referral&amp;page&#x3D;upgrade-pr)
> - 🔕 [Ignore this dependency or unsubscribe from future upgrade
PRs](https://app.snyk.io/org/newkdr/project/12a8a5f5-3e19-438c-8280-eb8f4ee06d17/settings/integration?pkg&#x3D;billboard.js&amp;utm_source&#x3D;github&amp;utm_medium&#x3D;referral&amp;page&#x3D;upgrade-pr#auto-dep-upgrades)

[//]: #
'snyk:metadata:{"customTemplate":{"variablesUsed":[],"fieldsUsed":[]},"dependencies":[{"name":"billboard.js","from":"3.14.0","to":"3.14.2"}],"env":"prod","hasFixes":false,"isBreakingChange":false,"isMajorUpgrade":false,"issuesToFix":[],"prId":"dca0e5b0-f67a-40d3-8409-9d31ae9d68c9","prPublicId":"dca0e5b0-f67a-40d3-8409-9d31ae9d68c9","packageManager":"npm","priorityScoreList":[],"projectPublicId":"12a8a5f5-3e19-438c-8280-eb8f4ee06d17","projectUrl":"https://app.snyk.io/org/newkdr/project/12a8a5f5-3e19-438c-8280-eb8f4ee06d17?utm_source=github&utm_medium=referral&page=upgrade-pr","prType":"upgrade","templateFieldSources":{"branchName":"default","commitMessage":"default","description":"default","title":"default"},"templateVariants":[],"type":"auto","upgrade":[],"upgradeInfo":{"versionsDiff":2,"publishedDate":"2024-11-26T05:44:58.122Z"},"vulns":[]}'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eamodio eamodio eamodio approved these changes

@d13 d13 Awaiting requested review from d13

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Remove unused media assets
2 participants
@nzaytsev @eamodio