diff --git a/packages/artifact/docs/implementation-details.md b/packages/artifact/docs/implementation-details.md index b30eaff4..d2f84646 100644 --- a/packages/artifact/docs/implementation-details.md +++ b/packages/artifact/docs/implementation-details.md @@ -1,5 +1,11 @@ # Implementation Details +Warning: Implementation details may change at any time without notice. This is meant to serve as a reference to help users understand the package. + +## Upload/Compression flow + +![image](https://user-images.githubusercontent.com/16109154/77190819-38685d80-6ada-11ea-8281-4703ff8cc025.png) + ## Proxy support This package uses the `@actions/http-client` NPM package internally which supports proxied requests out of the box. @@ -40,4 +46,4 @@ TCP connections consist of an input and output buffer to manage what is sent and ### Non Concurrent calls -Both `upload-http-client` and `download-http-client` do not instantiate or create any HTTP clients (the `HttpManager` has that responsibility). If an HTTP call has to be made that does not require the `keep-alive` header (such as when calling `listArtifacts` or `patchArtifactSize`), the first `HttpClient` in the `HttpManager` is used. The number of available clients is equal to the upload or download concurrency and there will always be at least one available. \ No newline at end of file +Both `upload-http-client` and `download-http-client` do not instantiate or create any HTTP clients (the `HttpManager` has that responsibility). If an HTTP call has to be made that does not require the `keep-alive` header (such as when calling `listArtifacts` or `patchArtifactSize`), the first `HttpClient` in the `HttpManager` is used. The number of available clients is equal to the upload or download concurrency and there will always be at least one available.