JavaScript walk through update #107
Conversation
docs/javascript-action.md
Outdated
| # Dev Workflow | ||
|
|
||
| The workflow below describes one possible workflow with a branching strategy. Others exist. | ||
|
|
||
| > Key Point: the branch that users reference in their workflow files should reference an action that has **only** the production dependencies. | ||
| > Key Point: the branch that users reference in their workflow files should reference an action from a distribution branch that has **only** the production dependencies. |
There was a problem hiding this comment.
This reads a bit confusing, can we add an example? "For instance, you would want to reference X and not Y".
There was a problem hiding this comment.
This is covered further down in the doc in the section for creating a distribution branch.
There was a problem hiding this comment.
The following paragraph also discussed a concrete distribution branch of releases/v1. It also clarifies that the runner will download and run from that distribution branch.
| runs: | ||
| using: 'node12' | ||
| main: 'lib/main.js' | ||
|
|
||
| ``` | ||
|
|
||
| The `name` input will be referenced by workflow authors using the `with:` keyword. |
There was a problem hiding this comment.
Yeah, it's covered in the Users referencing section further down in this doc but it's not using the with keyword. I will update this blurb to mention that and update that section to make it clearer.
| @@ -27,9 +27,9 @@ The toolkit provides five separate packages. See the docs for each action. | |||
|
|
|||
| Actions are units of work which can either run in a container or on the host machine. | |||
|
|
|||
| [Choosing an action type](docs/action-types.md): Outlines the differences and why you would want to create a host or a container based action. | |||
| [Choosing an action type](docs/action-types.md): Outlines the differences and why you would want to create a JavaScript or a container based action. | |||
There was a problem hiding this comment.
Should we make it explicit here that we recommend Typescript to make life easier?
There was a problem hiding this comment.
I think the next block covers that. Choosing an action type is orthogonal to dev tooling chosen. Case in point is our next action / in official docs is a topic on creating an action from scratch (hello world) in pure javascript. This doc strictly covers javascript vs container and why you would do one or the other.
| @@ -27,9 +27,9 @@ The toolkit provides five separate packages. See the docs for each action. | |||
|
|
|||
| Actions are units of work which can either run in a container or on the host machine. | |||
|
|
|||
| [Choosing an action type](docs/action-types.md): Outlines the differences and why you would want to create a host or a container based action. | |||
| [Choosing an action type](docs/action-types.md): Outlines the differences and why you would want to create a JavaScript or a container based action. | |||
There was a problem hiding this comment.
NOTE to self: need to add another block encouraging 1 action to 1 repo for market place and versioning to be viable in this model
| @@ -0,0 +1 @@ | |||
| <mxfile modified="2019-09-04T11:27:58.307Z" host="www.draw.io" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/76.0.3809.100 Safari/537.36" etag="MFzGVuAX-y50cwbudjLg" version="11.2.5" type="device" pages="1"><diagram name="Page-1" id="ff44883e-f642-bcb2-894b-16b3d25a3f0b">7Vtbc5s4GP01nj4lA+L+WCdp96E70910uu1TB4OMmWDkEdhx9tfvJ5AMSPIta4Mbx5mJ0R10zncVHll38/VnGi5mf5IYZyNkxOuRdT9CyHds+M8qXuoKxzPqioSmcV1lNhWP6b+YV4puyzTGRadjSUhWpotuZUTyHEdlpy6klDx3u01J1l11ESZYqXiMwkzU3jpN/T9pXM54vekGTcMfOE1mfHEfuXXDJIyeEkqWOV9xhKxp9amb56GYiz9qMQtj8tyqsh5G1h0lpKyv5us7nLHNFRsnxpUv4m5H1nhWzjMomHBZNX/aMtg8ZDA8HMV52V5u23xTYxJFQWAZNnanTngTKPPjGHaWF3OSw9c4WtIVjvmKrcWLMqQlJwMwwRrjPP7I0IRylIVFkUZ15ac0E2Og1B5RlJQ84TuSEVotbxnVZ9MisGSPPSX5ZjVUTVXSlx+beaHwEwoGUIEX7xm9jU3pRZTWafmjdd0aBaVmECuIMeo+C2TIkkZYv7mIS0JIE1zqu/BZ2Ka3puXYfcZkjuHOoQPFWVimq64QhFxqkk2/zdCvJIUbRQYXcFsIKpdvT8i3mKJ+DD6q4Q9ctG6jqapYdRjDTPfUFNvHpp2c0WG/E/kNy1rE+tkm3RaWvYox1n7GoH4YY0mM8WXG1Pd4FsbUC63CbMnvPlLVIEwBxoVR53mWlvhxEVZ7+gzmrcugSrVX1KoYIrS3qVM+bvVRiGR3iWSxicIsTXKm5wBeTFkHYGVrqqnD/nbxYIVpidc7MeStyO9isbHOz42lE11mbRtnbEe9g9cx4Kjm7NLEeY8qf63ZeJVAuxcj0E4gkcjqTaCRKtBoUIE2BxZo27scgbZUcKyrBseRwPHRcODYKjjOVYPjyVpsSFNov5vCI0yhvd8Uuv2YQs8azBS6qkBrWHRFAu3awwl08ovef//7r+Rhtfj+7UtBvkR3N5roY4TcDFYdT+AiqS5omEdwbx9FCyy0aYTvcM5wyicF+wKu4rDABfRZqWEMYLZgl1GYZWRZ7od8gWkKD8pgEYO+NlXjBSnSMiU5quTY9E9kEiWt69kqSCbqEyWNSznD0VOas0elJGa5TLwAJYrzKGWbzyGkAqZvuGAa4QE9KJjAppSyrm4LE1fsbaHgVYrgsC1OAaaPvGGexnG2TbC70nwK2XKdrifja2DTCRc6F2waZ1OTHroi9ee7wzmbWoTefZpdPs0uUu9ybKx+HBsnMG890/GQ7zng1XhBl1u2tnVPClhdBHUp67pn85602+0oOmSartmgolgyTW9MKZkzPEDDp3nydtW7Z3TVu2vZqno3+lTvl5nq3yiMgZP9r1Uedj/Kw5fzHgeeESkTubJNO9/RgXZLPUVBzDEsCFUgzGybJuCPv1214DuSftZEVHafWsFX8FAiqojisMQ1h3GFDtzMuJKLZGucZZi3EOKorr0y+85Jeg/KwO6eRv17clBmqurf7dN3DPYDfVToPA8LtoG/Z8yMpJjZDoaOmcXRXTv68lSLfUXRV3BxySfNQfcFeFBHhF+v94QEPc/u5xiSfZQN36F+juwwuWa/fo6pSYL51y3Pgd/1PIfOppiao9TfS577T6cIWrdDol2h03tcdCgZLzO3d2uDlDSEvDFujQMpeWSQziZp+X190bQvuxbIb+zJp5oH2zXJK+o7wWeqGb6rCuBNQ/ZQPEsxY71G8KZ6bF3nXCfLN5xf9QPZUVTzq/3CoGa2ytYxJgjGFFN24Mmy3oZ08Gzw0BsZH0DNwLAPcLnMea/47cIY2N1jkMBAA8N41oQYOiAhNicrvG+u3vNilv73LMfj7Xfx1r6s0GtezFQTY1tSW5chdJWrxm9KCunYxp/Exsnv8QWBApIOo7MJpZi4hdHuN3euByp/i1+5L5F5Pqx072jJkU3zUzS+7XFYzHSBzcFbtteBb22Io9kPUfc//XwZD09OOx3q55umfIJwsgQWFJtfRNbdm9+dWg//AQ==</diagram></mxfile> | |||
There was a problem hiding this comment.
Do we need this file/what is it doing?
There was a problem hiding this comment.
Yes! Try and update the image included without it ;) . It's a draw.io file per the file name and the xml declaration. ;)
No description provided.