From 99d7fb8e0baa62ccb4b2dfc244d463ea5cd95b86 Mon Sep 17 00:00:00 2001 From: Benjamin Loison Date: Tue, 1 Aug 2023 20:23:01 +0200 Subject: [PATCH] Set to uppercase API abbreviation Verified exhaustiveness with: ```sh grep -r 'api' --include='*.md' ``` --- CONTRIBUTING.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3269d1c0..fd93315d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ Please note that this project is released with a [Contributor Code of Conduct][c ## What should I know before submitting a pull request or issue -The code related to `upload-artifact` is split between this repository and [actions/toolkit](https://github.com/actions/toolkit) where the `@actions/artifact` npm package is housed. The npm package contains the core functionality to interact with artifacts. Any extra functionality on top of interacting with the apis such as search is inside this repository. +The code related to `upload-artifact` is split between this repository and [actions/toolkit](https://github.com/actions/toolkit) where the `@actions/artifact` npm package is housed. The npm package contains the core functionality to interact with artifacts. Any extra functionality on top of interacting with the APIs such as search is inside this repository. Artifact related issues will be tracked in this repository so please do not open duplicate issues in `actions/toolkit`. ## Submitting a pull request diff --git a/README.md b/README.md index 0da14ce3..39abf32b 100644 --- a/README.md +++ b/README.md @@ -251,7 +251,7 @@ The size of the artifact is denoted in bytes. The displayed artifact size denote ### Zipped Artifact Downloads -During a workflow run, files are uploaded and downloaded individually using the `upload-artifact` and `download-artifact` actions. However, when a workflow run finishes and an artifact is downloaded from either the UI or through the [download api](https://developer.github.com/v3/actions/artifacts/#download-an-artifact), a zip is dynamically created with all the file contents that were uploaded. There is currently no way to download artifacts after a workflow run finishes in a format other than a zip or to download artifact contents individually. One of the consequences of this limitation is that if a zip is uploaded during a workflow run and then downloaded from the UI, there will be a double zip created. +During a workflow run, files are uploaded and downloaded individually using the `upload-artifact` and `download-artifact` actions. However, when a workflow run finishes and an artifact is downloaded from either the UI or through the [download API](https://developer.github.com/v3/actions/artifacts/#download-an-artifact), a zip is dynamically created with all the file contents that were uploaded. There is currently no way to download artifacts after a workflow run finishes in a format other than a zip or to download artifact contents individually. One of the consequences of this limitation is that if a zip is uploaded during a workflow run and then downloaded from the UI, there will be a double zip created. ### Permission Loss