Commit Graph

64 Commits

Author SHA1 Message Date
Josh Soref 6201cb9bfa Improve trashcan documentation
Reorder paragraph to simplify messaging for only users with write permissions instead of getting people's hopes up that there might be a trash can only to dash it a sentence later.
2024-10-30 09:36:17 -04:00
Josh Soref f8fff0c1f0 Improve Zip archives documentation grammar
As the format is `Zip`, it's wrong to precede it with an article `a` which would be more appropriate for an instance of the format.
2024-10-30 09:36:17 -04:00
Josh Soref 55f5a1aa62 Improve outputs documentation
Use `the` for `artifact-id` as it's a precise instance and not an amorphous artifact.
Fix boolean grammar for `artifact-url` -- all conditions must be true in order for the `artifact-url` to be valid.
2024-10-30 09:36:17 -04:00
Josh Soref ecc6a0a912 Fix `include-hidden-files` documentation grammar 2024-10-30 09:36:17 -04:00
Josh Soref 3ebf8b2556 Improve `compression-level` documentation
Wrap text so that it isn't clipped when rendered in:
https://github.com/actions/upload-artifact?tab=readme-ov-file#inputs
2024-10-30 09:36:17 -04:00
Josh Soref fd99883423 Improve `retention-days` documentation
Clarify that `retention-days: 0` is a valid configuration which is numerically less than 1, but that the shortest retention is `1` (it is _not_ a minimum value according to Math/Numbers/Integers, it's just the shortest retention value).
Clarify that the maximum `retention-days` value is configured per repository (which implicitly inherits from organizations...) but that the default for repositories is 90 days.
2024-10-30 09:36:17 -04:00
Josh Soref 38ea23d5ce Improve `if-no-files-found` documentation
If `if-no-files-found: ignore` and `overwrite: false` and an artifact already exists, the action will fail, so clarify that `ignore` doesn't guarantee the action won't fail.
2024-10-30 09:36:11 -04:00
Josh Gross d7c12077c4
Add a section about hidden files 2024-09-02 10:30:03 -04:00
Josh Gross d52396ac5d
Add a warning about enabling `include-hidden-files` 2024-08-15 19:45:59 -04:00
Josh Gross cb6558bb10
Exclude hidden files by default 2024-08-15 16:22:09 -04:00
Rob Herley e63ea677fb
Update readme with v3/v2/v1 deprecation notice
- https://github.blog/changelog/2024-02-13-deprecation-notice-v1-and-v2-of-the-artifact-actions/
- https://github.blog/changelog/2024-04-16-deprecation-notice-v3-of-the-artifact-actions/
2024-04-16 16:48:37 -04:00
Mark Massoud 707f5a7b71
Update limitation of `10` artifacts upload to `500`
According to https://github.com/actions/upload-artifact/issues/470#issuecomment-1885881535, the limitation has been raised from `10` to `500`. This PR simply updates the docs to reflect the change.
2024-01-27 16:21:08 -05:00
Rob Herley 53ef6987b3
add additional integration test for merge all behavior 2024-01-23 11:15:52 -05:00
Rob Herley 40b3052821
update readme 2024-01-18 13:44:36 -05:00
Rob Herley 11ff42c7b1
add new overwrite input & docs 2024-01-18 13:31:03 -05:00
Rob Herley 8688a86492
Update readme to reflect new artifact/job limit 2024-01-10 15:23:13 -05:00
Konrad Pabjan 73d8b66ede
Support artifact-url output (#496)
* Support artifact-url output

* update dist/index.js

* Update license

* Simplify output

* Update README
2024-01-10 12:31:08 -05:00
shmuel c320f57948
Update README.md (#492)
Use correct id of step
2024-01-10 10:00:06 -05:00
Rob Herley 7f16e37e88
add migrations docs 2023-12-18 18:10:52 -05:00
Rob Herley 6c139afa6f
update imports and old v4-beta references 2023-12-14 15:08:24 -05:00
Rob Herley 9653d03c4b
Apply suggestions from code review
Co-authored-by: Konrad Pabjan <konradpabjan@github.com>
2023-12-13 12:24:16 -05:00
Rob Herley 875b630764
add limitations section 2023-12-13 11:55:56 -05:00
Rob Herley ecb21463e9
add compression example 2023-12-13 10:17:03 -05:00
Rob Herley 5e7604f84a
trim some repeated info 2023-12-12 23:27:17 -05:00
Rob Herley d6437d0758
naming 2023-12-12 23:24:58 -05:00
Rob Herley 1b56155703
s/v4-beta/v4/g 2023-12-12 23:21:37 -05:00
Rob Herley 6a5077f99b
update docs and bump @actions/artifact 2023-12-12 23:19:52 -05:00
Konrad Pabjan aa5cae10db
Add artifact-id output to v4-beta (#448)
* Add artifact-id to outputs

* ncc

---------

Co-authored-by: Rob Herley <robherley@github.com>
2023-10-26 12:05:31 -04:00
George Melikov e0057a5b76
README: Bump actions/checkout to v3 (#352)
`Node.js 12 actions are deprecated. For more information see: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/. Please update the following actions to use Node.js 16: actions/checkout, actions/checkout`

It's great to have non-deprecated examples.
2023-01-04 13:34:12 -05:00
Jonathan Tamsut 6673cd052c
Update `lockfileVersion` in `package-lock.json` (#302)
* update lockfileVersion

* regenerate package lock

* update actions/artifact package

* upgrade to v3

* bump license number

* bump upload-artifact package version

* regenerate index.js

* add newline

* generate release

* revert index.js

* use correct typescript version

* revert artifact version

* regenerate lock file

* revert to newer packages

* regenerate index.js

* use new version in README
2022-03-03 08:44:35 -08:00
Konrad Pabjan 87348cee5f
Add 503 warning when uploading to the same artifact 2022-01-20 15:26:28 +01:00
Jozef Izso f4ac36d205
Improve readme (#278) 2021-12-07 09:07:03 -05:00
Konrad Pabjan 5f375cca4b
Document how to correctly use environment variables for path input (#274)
* Update README.md

* Update README.md
2021-12-06 16:35:35 -05:00
Peter Mescalchin 0b3de3e43b
Fix `README.md` links and some formatting updates (#273)
* Some `README.md` whitespace and tweaks

* Fix link and title to GitHub documentation page on `README.md`

* Update link to `actions/toolkit` documentation

* De-quote some YAML blocks/examples in `README.md`
2021-12-01 08:48:09 -05:00
Robert Cannon 9243a41f97
Re-order example descriptions (#209)
Given the way that the two descriptions were written it was confusing about which example was being discussed (see specifically "In the above example in the previous version).
2021-05-21 19:28:43 +02:00
Remy Kabel 9dc0ee81a2
Fix spelling error (#204)
effect -> affect
2021-05-14 15:13:55 +02:00
Konrad Pabjan a4f98af3fa
Update README.md 2021-01-07 18:56:21 +01:00
Konrad Pabjan 16b8b2b2e7
Update where does the upload go section (#162) 2021-01-05 16:00:51 +01:00
Konrad Pabjan e4a7ffadfc
Update README with more retention documentation 2020-11-17 12:57:17 -05:00
Brian Westphal 726a6dcd01
Adding example of retention-days option. (#131) 2020-11-13 12:25:13 -05:00
Justin Weissig abecf4abf4
Updated README.md (#118)
Fixed minor spelling and grammar issues.
2020-09-18 17:36:35 -04:00
Konrad Pabjan 58740802ef
Update README.md 2020-08-11 18:20:19 +02:00
Konrad Pabjan c8879bf5ae
Detect case insensitive uploads + Bump @actions/artifact to version 0.3.3 (#106)
* Detect case insensitive uploads

* PR feedback
2020-07-31 19:22:08 +02:00
Konrad Pabjan 5ba29a7d5b
Add new option to specify behavior if no files found (#104)
* Add new option to specify behavior if no files found
2020-07-31 17:27:37 +02:00
Konrad Pabjan 8ec57c93cb
Update README.md 2020-07-14 12:25:21 +02:00
Konrad Pabjan f265ac5693
Multi Path Artifact Upload + Exclude Character Support (#94)
* Support for multi path upload

* Update README

* Fix tests

* Actually fix tests

* PR feedback

* Fix

* Apply suggestions from code review

Co-authored-by: Alberto Gimeno <gimenete@users.noreply.github.com>

* Fix more tests

Co-authored-by: Alberto Gimeno <gimenete@users.noreply.github.com>
2020-07-09 20:53:45 +02:00
Konrad Pabjan 4347a0d55a
Update README.md 2020-06-29 11:07:02 +02:00
Konrad Pabjan e7eefc4917
V2 Upload Artifact (#70)
* V2 Preview (#54)

* V2 Upload Artifact

* Improve logs

* Update release

* Update test.yml

* Update test.yml

* Update test.yml

* @actions/artifact v0.2.0 package

* Add extra YAML test

* Extra Documentation

* Update README.md

* Update README.md

* Update NPM packages

* Update to @actions/artifact 0.3.1

* Update readme from v2 preview to v2

* Add .gitattributes

* Misc Updates

* macOS to macos

* Update YAML so only push events trigger on the master branch
2020-04-28 17:18:53 +02:00
Manolo Edge 1283ca12b6
grammar: changed "trash can" to "trashcan" (#57) 2020-03-19 11:44:16 +01:00
Konrad Pabjan 8eb149d680
Update README.md 2020-01-16 14:38:17 -05:00