cake-build/cake

Feature request: built-in scheme for #tool to download an arbitrary HTTPS .zip file

Open

#2,731 opened on 2020年3月12日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)C# (3,742 stars) (738 forks)batch import
Help wantedUp-for-grabs

説明

Parameters

  • Version parameter: no. There would be no notion of the downloaded tool having a version, so no version or prerelease parameters.

  • Format parameter: maybe The format could be autodetected from the content type or file contents in case you eventually support archive formats other than .zip. There probably wouldn't be a need for a type/format parameter but it might be desirable.

  • Checksum parameter: I want this. Even if the download is over HTTPS, it's nice to know if something else starts getting served. This would make HTTP/FTP URLs safe too. If the checksum is missing, Cake could download the file and then include the checksum in an error message requiring the checksum to be present in the .cake file.

Since query parameters in the same URL would collide with the URL to use for the download whether or not they are excluded when downloading, there would need to be a new way to handle this.

Proposal

#tool download: followed by a URL. If the URL contains a comma, it must be URL-encoded.

A parameter may be specified no more than once. Some parameters are required. To specify a parameter, add a comma to the end of the line followed by the parameter name, an equals sign, and a parameter value. If the parameter value contains a double quote character or comma, the whole parameter value must be double-quoted.

Valid parameter names:

  • checksum: Required. Value must start with SHA256: and the remainder must be 32 hex characters, case-insensitive. Future checksums may be supported.
#tool download:http://static.wixtoolset.org/releases/v3.14.0.3910/wix314-binaries.zip, checksum=SHA256:0904A88A4BCD9DD3C2274CAABE73989CD72767EE90C8FA0BF813D004EEC90D32

Questions

  1. Is a format parameter desirable even if multiple formats become supported?

  2. Should there be support for the file scheme or absolute or relative or Windows UNC paths?

  3. Should checksum be allowed to be omitted for HTTPS downloads? What about HTTP/FTP/file schemes?

コントリビューターガイド

技術スタック
csharp
領域
build system
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
4
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
C#HTTP client usageCake build system internalssecurity checksums
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
25
調査方針
Examine the existing #tool directive implementation in the Cake codebase to understand syntax parsing and download logic. Pay attention to how parameters are currently handled. The issue proposes a new 'download:' scheme with checksum support. Consider reviewing files like src/Cake.Core/Tooling/ToolResolutionStrategy.cs or related parser files. Address the open questions about format parameter, file scheme support, and omitting checksum for HTTPS.
Feature request: built-in scheme for #tool to download an arbitrary HTTPS .zip file · cake-build/cake#2731 | Good First Issue