formatting fixes

adding hyperlinks for new section of artifacts faq

packages/artifact/__tests__/config.test.ts

@@ -0,0 +1,22 @@
+import * as config from '../src/internal/shared/config'
+
+beforeEach(() => {
+  jest.resetModules()
+})
+
+describe('isGhes', () => {
+  it('should return false when the request domain is github.com', () => {
+    process.env.GITHUB_SERVER_URL = 'https://github.com'
+    expect(config.isGhes()).toBe(false)
+  })
+
+  it('should return false when the request has ACTIONS_RESULTS_URL set', () => {
+    process.env.ACTIONS_RESULTS_URL = 'my.results.url'
+    expect(config.isGhes()).toBe(false)
+  })
+
+  it('should return false when the request domain is specific to an enterprise', () => {
+    process.env.GITHUB_SERVER_URL = 'https://my-enterprise.github.com'
+    expect(config.isGhes()).toBe(true)
+  })
+})

packages/artifact/docs/faq.md

@@ -3,6 +3,8 @@
 - [Frequently Asked Questions](#frequently-asked-questions)
   - [Supported Characters](#supported-characters)
   - [Compression? ZIP? How is my artifact stored?](#compression-zip-how-is-my-artifact-stored)
+  - [Which versions of the artifacts packages are compatible?](#which-versions-of-the-artifacts-packages-are-compatible)
+  - [How long will my artifact be available?](#how-long-will-my-artifact-be-available)
 
 ## Supported Characters
 
@@ -35,22 +37,26 @@ Higher levels will result in better compression, but will take longer to complet
 For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads.
 
 ## Which versions of the artifacts packages are compatible?
-[actions/upload-artifact](https://github.com/actions/upload-artifact) and [actions/download-artifact](https://github.com/actions/download-artifact), are part of the [GitHub Actions toolkit](https://github.com/actions/toolkit) and are typically used together to upload and download artifacts in your workflows.
+[actions/upload-artifact](https://github.com/actions/upload-artifact) and [actions/download-artifact](https://github.com/actions/download-artifact), leverage [GitHub Actions toolkit](https://github.com/actions/toolkit) and are typically used together to upload and download artifacts in your workflows.
 
-1. **Matching Versions:**
+| upload-artifact | download-artifact | toolkit |
-	- Use matching versions of `actions/upload-artifact` and `actions/download-artifact` to ensure compatibility.
+|---|---|---|
+| v4 | v4 | v2 |
+| < v3 | < v3 | < v1 |
 
-2. **Workflow YAML File:**
+Use matching versions of `actions/upload-artifact` and `actions/download-artifact` to ensure compatibility.
-   - In your GitHub Actions workflow YAML file, you specify the version of the actions you want to use. For example:
-     ```yaml
-     uses: actions/upload-artifact@v4
-     # ...
-     uses: actions/download-artifact@v4
-     # ...
-     ```
 
-3. **Release Notes:**
+In your GitHub Actions workflow YAML file, you specify the version of the actions you want to use. For example:
-   - Check the release notes for each repository to see if there are any specific notes about compatibility or changes in behavior.
+
+```yaml
+  uses: actions/upload-artifact@v4
+  # ...
+  uses: actions/download-artifact@v4
+  # ...
+```
+
+**Release Notes:**
+Check the release notes for each repository to see if there are any specific notes about compatibility or changes in behavior.
 
 ## How long will my artifact be available?
-The default retention period is 90 days. For more information, visit: https://github.com/actions/upload-artifact?tab=readme-ov-file#retention-period 
+The default retention period is **90 days**. For more information, visit: https://github.com/actions/upload-artifact?tab=readme-ov-file#retention-period 

packages/artifact/src/internal/find/get-artifact.ts

@@ -49,7 +49,9 @@ export async function getArtifactPublic(
 
   if (getArtifactResp.data.artifacts.length === 0) {
     throw new ArtifactNotFoundError(
-      `Artifact not found for name: ${artifactName}`
+      `Artifact not found for name: ${artifactName}
+        Please ensure that your artifact is not expired and the artifact was uploaded using a compatible version of toolkit/upload-artifact.
+        For more information, visit the GitHub Artifacts FAQ: https://github.com/actions/toolkit/blob/main/packages/artifact/docs/faq.md`
     )
   }
 
@@ -89,7 +91,9 @@ export async function getArtifactInternal(
 
   if (res.artifacts.length === 0) {
     throw new ArtifactNotFoundError(
-      `Artifact not found for name: ${artifactName}`
+      `Artifact not found for name: ${artifactName}
+        Please ensure that your artifact is not expired and the artifact was uploaded using a compatible version of toolkit/upload-artifact.
+        For more information, visit the GitHub Artifacts FAQ: https://github.com/actions/toolkit/blob/main/packages/artifact/docs/faq.md`
     )
   }
 

packages/artifact/src/internal/shared/config.ts

@@ -27,7 +27,12 @@ export function isGhes(): boolean {
   const ghUrl = new URL(
     process.env['GITHUB_SERVER_URL'] || 'https://github.com'
   )
-  return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM'
+
+  const isGitHubHost = ghUrl.hostname.trimEnd().toUpperCase() === 'GITHUB.COM'
+  const isResultsServiceRequest =
+    process.env['ACTIONS_RESULTS_URL'] != undefined
+
+  return !isGitHubHost && !isResultsServiceRequest
 }
 
 export function getGitHubWorkspaceDir(): string {

packages/cache/__tests__/cacheUtils.test.ts

@@ -2,6 +2,10 @@ import {promises as fs} from 'fs'
 import * as path from 'path'
 import * as cacheUtils from '../src/internal/cacheUtils'
 
+beforeEach(() => {
+  jest.resetModules()
+})
+
 test('getArchiveFileSizeInBytes returns file size', () => {
   const filePath = path.join(__dirname, '__fixtures__', 'helloWorld.txt')
 
@@ -38,3 +42,13 @@ test('resolvePaths works on github workspace directory', async () => {
   const paths = await cacheUtils.resolvePaths([workspace])
   expect(paths.length).toBeGreaterThan(0)
 })
+
+test('isGhes returns false for github.com', async () => {
+  process.env.GITHUB_SERVER_URL = 'https://github.com'
+  expect(cacheUtils.isGhes()).toBe(false)
+})
+
+test('isGhes returns true for enterprise URL', async () => {
+  process.env.GITHUB_SERVER_URL = 'https://my-enterprise.github.com'
+  expect(cacheUtils.isGhes()).toBe(true)
+})

packages/cache/src/internal/cacheUtils.ts

@@ -7,11 +7,7 @@ import * as path from 'path'
 import * as semver from 'semver'
 import * as util from 'util'
 import {v4 as uuidV4} from 'uuid'
-import {
+import {CacheFilename, CompressionMethod} from './constants'
-  CacheFilename,
-  CompressionMethod,
-  GnuTarPathOnWindows
-} from './constants'
 
 // From https://github.com/actions/toolkit/blob/main/packages/tool-cache/src/tool-cache.ts#L23
 export async function createTempDirectory(): Promise<string> {
@@ -56,12 +52,7 @@ export async function resolvePaths(patterns: string[]): Promise<string[]> {
       .replace(new RegExp(`\\${path.sep}`, 'g'), '/')
     core.debug(`Matched: ${relativeFile}`)
     // Paths are made relative so the tar entries are all relative to the root of the workspace.
-    if (relativeFile === '') {
+    paths.push(`${relativeFile}`)
-      // path.relative returns empty string if workspace and file are equal
-      paths.push('.')
-    } else {
-      paths.push(`${relativeFile}`)
-    }
   }
 
   return paths
@@ -71,15 +62,11 @@ export async function unlinkFile(filePath: fs.PathLike): Promise<void> {
   return util.promisify(fs.unlink)(filePath)
 }
 
-async function getVersion(
+async function getVersion(app: string): Promise<string> {
-  app: string,
+  core.debug(`Checking ${app} --version`)
-  additionalArgs: string[] = []
-): Promise<string> {
   let versionOutput = ''
-  additionalArgs.push('--version')
-  core.debug(`Checking ${app} ${additionalArgs.join(' ')}`)
   try {
-    await exec.exec(`${app}`, additionalArgs, {
+    await exec.exec(`${app} --version`, [], {
       ignoreReturnCode: true,
       silent: true,
       listeners: {
@@ -98,14 +85,23 @@ async function getVersion(
 
 // Use zstandard if possible to maximize cache performance
 export async function getCompressionMethod(): Promise<CompressionMethod> {
-  const versionOutput = await getVersion('zstd', ['--quiet'])
+  if (process.platform === 'win32' && !(await isGnuTarInstalled())) {
-  const version = semver.clean(versionOutput)
+    // Disable zstd due to bug https://github.com/actions/cache/issues/301
-  core.debug(`zstd version: ${version}`)
-
-  if (versionOutput === '') {
     return CompressionMethod.Gzip
-  } else {
+  }
+
+  const versionOutput = await getVersion('zstd')
+  const version = semver.clean(versionOutput)
+
+  if (!versionOutput.toLowerCase().includes('zstd command line interface')) {
+    // zstd is not installed
+    return CompressionMethod.Gzip
+  } else if (!version || semver.lt(version, 'v1.3.2')) {
+    // zstd is installed but using a version earlier than v1.3.2
+    // v1.3.2 is required to use the `--long` options in zstd
     return CompressionMethod.ZstdWithoutLong
+  } else {
+    return CompressionMethod.Zstd
   }
 }
 
@@ -115,12 +111,9 @@ export function getCacheFileName(compressionMethod: CompressionMethod): string {
     : CacheFilename.Zstd
 }
 
-export async function getGnuTarPathOnWindows(): Promise<string> {
+export async function isGnuTarInstalled(): Promise<boolean> {
-  if (fs.existsSync(GnuTarPathOnWindows)) {
-    return GnuTarPathOnWindows
-  }
   const versionOutput = await getVersion('tar')
-  return versionOutput.toLowerCase().includes('gnu tar') ? io.which('tar') : ''
+  return versionOutput.toLowerCase().includes('gnu tar')
 }
 
 export function assertDefined<T>(name: string, value?: T): T {