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

Runs Plugin: 'publish' - Undocumented Feature #69

Closed
warrenbuckley opened this issue Aug 20, 2019 · 6 comments
Closed

Runs Plugin: 'publish' - Undocumented Feature #69

warrenbuckley opened this issue Aug 20, 2019 · 6 comments
Assignees

Comments

@warrenbuckley
Copy link
Contributor

The https://github.com/actions/upload-artifact repo action.yml contains the following:

https://github.com/actions/upload-artifact/blob/ec188c28d23c831d7283eb4280a4490eb5010092/action.yml#L11-L12

name: 'Upload artifact'
description: 'Publish files as workflow artifacts'
author: 'GitHub'
inputs: 
  name:
    description: 'Artifact name'
    required: true
  path:
    description: 'Directory containing files to upload'
    required: true
runs:
  plugin: 'publish'

So this leaves me to ask, what other things apart from running NodeJS & Docker Image/Container can we do as Action developers as mentioned in the documentation here - https://help.github.com/en/articles/metadata-syntax-for-github-actions#runs

/cc @chrispat & @damccorm

@damccorm
Copy link
Contributor

That's actually intentional - plugins live on our Runner which isn't open sourced yet (though it will be). Basically, certain actions are (a) definitely needed to support the product/expected to be used in a large percentage of workflows, but (b) much easier to implement well directly on the Runner. So while we have this concept of a plugin for a small/select group of first party actions, this is not the path for creating future actions (unless there's a very clear and obvious need).

@damccorm damccorm self-assigned this Aug 20, 2019
@warrenbuckley
Copy link
Contributor Author

warrenbuckley commented Aug 20, 2019

Thanks for the explanation. Will close this issue for now as its not intended for public consumption by action developers @damccorm

@svenstaro
Copy link
Contributor

I think this should be re-opened and still be documented nonetheless. Otherwise there'll be more people confused by this.

@mark-rushakoff
Copy link

Agreed -- please at least put a comment in upload-artifact's action.yml, so that nobody else wastes 5-10 minutes trying to figure out what plugin: 'publish' is all about.

@damccorm
Copy link
Contributor

damccorm commented Sep 6, 2019

It would feel a little weird to me to have docs saying "we don't support this", but I think a comment in the action.yml file makes sense.

Will add one in checkout, upload-artifact, and download-artifact, I think that's everywhere this is used.

@svenstaro
Copy link
Contributor

svenstaro commented Sep 6, 2019 via email

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

No branches or pull requests

4 participants