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.

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

Fix typo with v3 artifact downloads in migration guide #511

Merged
merged 2 commits into from Jan 31, 2024

Conversation

robherley
Copy link
Contributor

@robherley robherley commented Jan 31, 2024

In the migration guide, the download for the v3 was as follows:

      - name: Download All Artifacts
        uses: actions/download-artifact@v3
        with:
          path: my-artifact
      - run: ls -R my-artifact

And it was stated that it would create the following directory:

my-artifact/
  file-macos-latest.txt
  file-ubuntu-latest.txt
  file-windows-latest.txt

This was incorrect, since no name was specified, it actually made an inner directory due to the behavior outlined here in the v3 docs.

If the name input parameter is not provided, all artifacts will be downloaded. To differentiate between downloaded artifacts, a directory denoted by the artifacts name will be created for each individual artifact.

Instead we must provide both the name and the path to have it match the scenario we outlined.

More context: #478 (comment)

@robherley robherley requested a review from a team as a code owner January 31, 2024 17:30
@robherley robherley merged commit 3a80482 into main Jan 31, 2024
3 checks passed
@jsoref
Copy link

jsoref commented Feb 1, 2024

Migrating says "The new merge-multiple: input will support downloading multiple artifacts within the same directory." That isn't technically wrong, but from the perspective of migrating users, it is.

It would be better to say:
"If you previously used name:, you will need to replace it with merge-multiple: true -- noting that these are not precisely equivalent."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants