Skip to content

@actions/artifact doc updates#1594

Merged
robherley merged 18 commits intomainfrom
robherley/artifact-docs-updates
Dec 6, 2023
Merged

@actions/artifact doc updates#1594
robherley merged 18 commits intomainfrom
robherley/artifact-docs-updates

Conversation

@robherley
Copy link
Copy Markdown
Contributor

@robherley robherley commented Dec 6, 2023

This starts the initial documentation for @action/artifact v2.

I'll be following up in another PR with autogenerated markdown docs for the functions, interfaces, etc.

Also, this change alters the export behavior of the default client.

Instead of:

import * as artifact from '@actions/artifact'
const artifactClient = artifact.create()

artifact.getArtifact( /* ... */ )

Now there is a default export with the client already initialized:

import artifact from '@actions/artifact'

artifact.getArtifact( /* ... */ )

@robherley robherley marked this pull request as ready for review December 6, 2023 14:08
@robherley robherley requested review from a team as code owners December 6, 2023 14:08
Copy link
Copy Markdown
Contributor

@bethanyj28 bethanyj28 left a comment

Choose a reason for hiding this comment

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

A few suggestions, overall looks good!

Comment thread packages/artifact/README.md Outdated
Comment thread packages/artifact/README.md Outdated
Comment thread packages/artifact/README.md Outdated
Comment thread packages/artifact/README.md Outdated
Comment thread packages/artifact/RELEASES.md Outdated
Comment thread packages/artifact/docs/faq.md Outdated
@robherley robherley requested a review from bethanyj28 December 6, 2023 14:56
Copy link
Copy Markdown
Contributor

@bethanyj28 bethanyj28 left a comment

Choose a reason for hiding this comment

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

🚀

Copy link
Copy Markdown
Contributor

@mattiaerre mattiaerre left a comment

Choose a reason for hiding this comment

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

some vminor comments

Comment thread packages/artifact/README.md Outdated
Comment thread packages/artifact/README.md Outdated
- [Additional Resources](#additional-resources)

This package is currently undergoing a major overhaul in preparation for `v4` versions of `upload-artifact` and `download-artifact` (these Actions will use a new `2.0.0` version of `@actions/artifact` that will soon be released). The upcoming version of `@actions/artifact` will take advantage of a major re-architecture with entirely new APIs.
## v2 - What's New
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.

so v2 is to support Artifacts v4?

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.

Yea, the NPM package version of @actions/artifact is currently at v1.1.2. It drifts a bit from the actual actions versions, which get major bumps for other reasons (like node updates)

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.

do you think we could follow the same versioning? can these be aligned? bad idea?

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.

I don't think so, it'll cause some confusion on the missing v3 and v4 versions.

And even if we did, the actions will probably deviate in the future too

Comment thread .github/workflows/artifact-tests.yml
Comment thread packages/artifact/README.md Outdated
Comment thread packages/artifact/RELEASES.md
Comment thread packages/artifact/README.md Outdated
Comment thread packages/artifact/README.md
Comment thread packages/artifact/README.md Outdated
Comment thread packages/artifact/README.md Outdated
Comment thread packages/artifact/CONTRIBUTIONS.md Outdated
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.

4 participants