actions
/
toolkit
mirror of https://github.com/actions/toolkit
1
0
Fork 0
Code

new template doc links

pull/131/head
Bryan MacFarlane 2019-09-11 03:35:39 -04:00
parent 5fd70ca47a
commit da04d22321
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -25,11 +25,15 @@ The toolkit provides five separate packages. See the docs for each action.
## Creating an Action with the Toolkit
Actions are units of work which can either run in a container or on the host machine.
Actions 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 JavaScript or a container based action.
[JavaScript Action Walkthrough using a Template](docs/javascript-action.md): A full walkthrough creating an action using the toolkit along with TypeScript for compile time support and Jest for unit testing. It also covers a branching strategy for versioning and safely testing and releasing an action.
[Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action): Illustrates how to create a simple hello world javascript action.
[JavaScript Action Walkthrough](https://github.com/actions/javascript-action): Walkthrough creating a JavaScript Action with tests, linting, workflow, publishing, and versioning.
[TypeScript Action Walkthrough](docs/typescript-action.md): Walkthrough creating a TypeScript Action with compilation, tests, linting, workflow, publishing, and versioning.
[Docker Action Walkthrough](docs/container-action.md): Create an action that is delivered as a container and run with docker.

4
docs/javascript-action.md → docs/typescript-action.md
View File

@ -1,10 +1,10 @@
# Creating a JavaScript Action
The [javascript-template](https://github.com/actions/javascript-template) repo contains everything you need to get started.
The [typescript-action](https://github.com/actions/typescript-action) repo contains everything you need to get started.
# Create a Repo from the Template
Navigate to https://github.com/actions/javascript-template
Navigate to https://github.com/actions/typescript-action
Click on `Use this template` to create the repo for your action. Provide a name such as `myaction` (used in rest of walk through).