Skip to content

Update the readme - #473

Merged
danwkennedy merged 6 commits into
mainfrom
danwkennedy/update-readme
Mar 12, 2026
Merged

danwkennedy merged 6 commits into
mainfrom
danwkennedy/update-readme

Conversation

@danwkennedy

Copy link
Copy Markdown
Contributor

Description

  • Bump actions versions on the examples
  • Add usage docs for new parameters
  • Remove all the new versions and point to the releases page instead (what's new was starting to push the usage/examples further and further down the page)
  • Add examples for direct downloads
  • Move the permission loss note into an example since we support direct upload/download

@danwkennedy
danwkennedy requested a review from a team as a code owner March 11, 2026 20:06
Copilot AI review requested due to automatic review settings March 11, 2026 20:06

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the repository README to better focus on current usage of actions/download-artifact, while moving version-specific change logs to the GitHub Releases page.

Changes:

  • Replace the detailed “What’s new” sections with a link to the releases page.
  • Bump action versions in examples (e.g., download-artifact@v8, upload-artifact@v7) and add docs for new inputs (skip-decompress, digest-mismatch).
  • Add examples for direct (non-zipped) downloads and move file-permissions guidance into an example.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md

## v4 - What's new

> [!IMPORTANT]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This info is still important and we should make sure it's highly discoverable?

@danwkennedy danwkennedy Mar 11, 2026 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it enough to copy that over to the release? We can backfill those descriptions. This version in particular (v4) still get less and less discoverable the more versions we release. Maybe we should have a v4 section/note calling out the lack of GHES support for now.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added back the GHES support note.

yacaovsnc
yacaovsnc previously approved these changes Mar 12, 2026
@danwkennedy
danwkennedy merged commit 484a0b5 into main Mar 12, 2026
4 checks passed
@danwkennedy
danwkennedy deleted the danwkennedy/update-readme branch March 12, 2026 13:59
ziemowit-orlikowski added a commit to Elmnt-Internal/download-artifact that referenced this pull request Jul 1, 2026
* docs: small migration fix

* Update MIGRATION.md

Fixing the broken link pointing to `actions/upload-artifact` content outside of the repository.

cc: @pedrolacerda

* Update artifact package to 2.2.2

* Bump artifact version, do digest check

* Refactor loop

* update dist

* Refactor loop, break for testing

* unbreak testing code

* Break the thing, also log the expected digest

* run release

* Make work as intended

* Update README.md

removing deprecation warning

* Bump artifact package

* Update artifact license

* Update artifact to 2.3.2

* Update dist

* Fix bug introduced in 4.2.0

* dist & package.json

* Add tests & test dependencies

* Lint

* Unfix error

* Configure tsconfig

* lint

* Add extra assertion to download single artifact test

* lint

* Run unit tests in CI

* Move log statements

* implement new `artifact-ids` input

* apply actions#401 (comment) suggestion

* when only one artifact-id is given, use `getArtifact` and check the resulting id returned

* bundle

* use the same `artifactClient.getArtifact` structure as seen above in `isSingleArtifactDownload` logic

* bundle

* revert `getArtifact()` changes - for now we have to list and filter by artifact-ids until a `getArtifactById()` public method exists

* add supporting unit tests for artifact downloads with ids

* Fix workflow example for downloading by artifact ID

* Remove path filters from Check dist workflow

* prep for v4.3.0 release

* Update README.md

* Update to Node.js 24 and related dependencies

Bump Node.js version to 24 in workflows, action definition, and package requirements. Update @types/node to 24.1.0 and add engines field to enforce Node.js >=24. This ensures compatibility with the latest Node.js features and ecosystem.

* fix download path logic when downloading a single artifact by id

* update docs

* bundle dist

* refactor: resolve download path correctly in artifact download tests (mainly for windows unit tests)

* Update README for download-artifact v5 changes

Updated documentation for download-artifact action to reflect changes in version 5.

* Update README.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Remove migration guide for artifact download changes

Readme probably should be less verbose since it's not a changelog.

* Update README with artifact extraction details

Clarified note on artifact extraction and GHES support.

* Readme: spell out the first use of GHES

* Update to use local artifact package v3.0.0

- Switch from @actions/artifact@^2.3.2 to file:../packages/artifact
- Add uri-js-replace security override
- Update @actions/github to v6.0.1 for security fixes
- Rebuild dist/index.js with updated dependencies
- Fix all security vulnerabilities (0 remaining)

* update licenses

* Update licensed configuration for new dependencies with Node 24 support

* Fix licensed configuration by ignoring packages with missing license text

* update

* Update licensed workflow to cache dependencies before status check

* Revert licensed workflow changes - keep original behavior

* update licences with temp not using package

* update dist

* Prepare `v6.0.0`

* Remove `github.dep.yml`

* Revert "Remove `github.dep.yml`"

This reverts commit bb3a066.

* Update GHES guidance to include reference to Node 20 version

* Fix typo in URL

* chore: use local @actions/artifact and @actions/core packages

* chore: update dependencies to use published npm packages

* chore: update @actions/artifact to use npm package v5.0.0

- Changed from file:../packages/artifact to 5.0.0
- Regenerated package-lock.json

* chore: regenerate license cache and fix @bufbuild/protobuf license

* chore: add minimatch.dep.yml license file

* chore: use local @actions/artifact package for Node.js 24 testing

This branch uses a local file reference to @actions/artifact which includes
the updated @azure/storage-blob ^12.29.1 to fix the punycode deprecation
warning on Node.js 24.

This is a test branch - do not merge until @actions/artifact@5.0.1 is published.

* fix: update @actions/artifact to ^5.0.0 for Node.js 24 punycode fix

Updates @actions/artifact dependency to use the published npm version
which includes @azure/storage-blob ^12.29.1 that fixes the punycode
deprecation warning on Node.js 24.

* chore: update package-lock.json with @actions/artifact@5.0.1

* chore: update @actions/artifact license file to 5.0.1

* chore: remove obsolete dependency license files

* chore: restore minimatch.dep.yml license file

* chore: release v7.0.0 for Node.js 24 support

- Update to Node.js 24 runtime (runs.using: node24)
- Bump version to 7.0.0
- Update README with v7 release notes
- Rebuild dist

* doc: update readme

* Update .gitignore

* Migrate eslint to `v9`

* Upgrade jest and typescript

* Don't attempt to un-zip non-zipped downloads

* Add tests

* Add an integration test for `skip-decompress`

* Update the integration test

* Cache licenses

* Updated the licensed version

* Revert "Updated the licensed version"

This reverts commit e6afc5e.

* Re-add minimatch.dep.yml

* Fixup the minimatch license

* Fix skip decompress test

* One more test fix

* Update test names to make it clearer what they do

* Bump the version to `v8` and add release notes

* Add note about package bumps

* Add a setting to specify what to do on hash mismatch and default it to `error`

* Fix linting issues

* Add change docs

* Add a regression test for artifact name + content-type mismatches (actions#472)

* Add a regression test for artifact name + content-type mismatches

* Specify that we want v4 in a comment

* Fix the expected type

* Add regression tests for CJK characters (actions#471)

* Add regression tests for CJK characters

* Dedupe the names and remove the ignored `name` param

* Bump @actions/artifact to v6.2.1

* Run `npm run release`

* Update licenses

* Update the readme (actions#473)

* Update the readme

* Update upload artifact versions

* Add back the GHES support note

* Update the skip-decompress description

* Be more specific with the direct download example

* Add GHES support section to TOC

---------

Co-authored-by: Francisco Robles Martín <f.robles.martin@pm.me>
Co-authored-by: Josh Gross <joshmgross@github.com>
Co-authored-by: Andy Feller <andyfeller@github.com>
Co-authored-by: Rob Herley <robherley@github.com>
Co-authored-by: Yang Cao <yacaovsnc@github.com>
Co-authored-by: Ryan Ghadimi <114221941+GhadimiR@users.noreply.github.com>
Co-authored-by: Larissa Fortuna <56982181+lkfortuna@users.noreply.github.com>
Co-authored-by: JoannaaKL <joannaakl@github.com>
Co-authored-by: Grant Birkinbine <grant.birkinbine@gmail.com>
Co-authored-by: Ben De St Paer-Gotch <nebuk89@github.com>
Co-authored-by: Salman Muin Kayser Chishti <salmanmkc@github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Daniel Kennedy <danwkennedy@github.com>
Co-authored-by: Patrik Polyak <patrikpolyak@github.com>
Co-authored-by: Zachary Taylor <zaataylor@github.com>
dbmikus pushed a commit to gofixpoint/amika that referenced this pull request Oct 23, 2026
Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 4.3.0 to 8.0.2.

## Release notes

Sourced from actions/download-artifact's releases.

### v8.0.2

### What's Changed
- Update the readme by `@danwkennedy` in actions/download-artifact#473
- Improves artifact download retries when the service returns HTTP 429 (rate limiting), including honoring valid Retry-After headers.
- Update `@actions/artifact` to 6.3.1 by `@tunc-d` in actions/download-artifact#492
- Prepare download-artifact v8.0.2 by `@tunc-d` in actions/download-artifact#493

### New Contributors
- `@tunc-d` made their first contribution in actions/download-artifact#492

Full Changelog: actions/download-artifact@v8.0.1...v8.0.2

### v8.0.1

### What's Changed
- Support for CJK characters in the artifact name by `@danwkennedy` in actions/download-artifact#471
- Add a regression test for artifact name + content-type mismatches by `@danwkennedy` in actions/download-artifact#472

Full Changelog: actions/download-artifact@v8...v8.0.1

### v8.0.0

### v8 - What's new

[!IMPORTANT]
actions/download-artifact@v8 has been migrated to an ESM module. This should be transparent to the caller but forks might need to make significant changes.

[!IMPORTANT]
Hash mismatches will now error by default. Users can override this behavior with a setting change (see below).

### Direct downloads

To support direct uploads in `actions/upload-artifact`, the action will no longer attempt to unzip all downloaded files. Instead, the action checks the `Content-Type` header ahead of unzipping and skips non-zipped files. Callers wishing to download a zipped file as-is can also set the new `skip-decompress` parameter to `true`.

### Enforced checks (breaking)

A previous release introduced digest checks on the download. If a download hash didn't match the expected hash from the server, the action would log a warning. Callers can now configure the behavior on mismatch with the `digest-mismatch` parameter. To be secure by default, we are now defaulting the behavior to `error` which will fail the workflow run.

### ESM

To support new versions of the @actions/* packages, we've upgraded the package to ESM.

### What's Changed
- Don't attempt to un-zip non-zipped downloads by `@danwkennedy` in actions/download-artifact#460
- Add a setting to specify what to do on hash mismatch and default it to `error` by `@danwkennedy` in actions/download-artifact#461

Full Changelog: actions/download-artifact@v7...v8.0.0

### v7.0.0

### v7 - What's new

... (truncated)

## Commits
- `9000827` Merge pull request #493 from actions/tunc-d-prepare-download-v8-0-2
- `e455989` Prepare download-artifact v8.0.2
- `a00b90c` Merge pull request #492 from actions/tunc-d-download-artifact-package-bump
- `29bb7ce` Update `@actions/artifact` to 6.3.1
- `484a0b5` Update the readme (#473)
- `3e5f45b` Add regression tests for CJK characters (#471)
- `e6d03f6` Add a regression test for artifact name + content-type mismatches (#472)
- `70fc10c` Merge pull request #461 from actions/danwkennedy/digest-mismatch-behavior
- `f258da9` Add change docs
- `ccc058e` Fix linting issues
- Additional commits viewable in compare view
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.

3 participants