actions
/
toolkit
mirror of https://github.com/actions/toolkit
1
0
Fork 0
Code
73 Commits
176 Branches
19 Tags
22 MiB
TypeScript 98.8%
JavaScript 0.8%
PowerShell 0.3%
 
 
 
Go to file
Danny McCormick 08db5110c6
Add io (#5) 
* Add io lib

* io cleanup

* Run format script

* Fix lint errors with autofix

* Fix equality lint errors

* Rename ioUtil to io-util

* Add no-import-requires

* Run auto-fix lint

* Remove lint errors

* Use Boolean() to convert options

- `CopyOptions` on `cp` now defaults to empty
- Setting option values is easier now

* Rewrite packages/io to be fully async

* Move IS_WINDOWS into ioUtil

* DRY up cp/mv by moving shared code into move function

* Remove unc support, change isDirectory call to stat

* Tighter try catches

* more concise extensions search

* Allow isDirectory to be stat or lstat

* format

* Shell out to rm -rf

* Remove unc comment

* Export fs.promises from io-util

* Remove unknown error message

* Create an optimistic mkdirp

* Update io-util.ts

* Update io-util.ts

* Update io.test.ts

* Fix tests for mkdirP
 		2019-05-22 16:05:34 -04:00
.github Add Lint action to main.workflow 2019-05-21 10:36:00 -04:00
docs Merge branch 'master' into features/core 2019-05-21 10:18:33 -04:00
packages Add io (#5) 2019-05-22 16:05:34 -04:00
scripts Simplify package creation 2019-04-22 11:54:05 -04:00
.eslintignore DRY up core tests 2019-05-21 11:23:35 -04:00
.eslintrc.json Add io (#5) 2019-05-22 16:05:34 -04:00
.gitignore Add io (#5) 2019-05-22 16:05:34 -04:00
.prettierignore Add .prettierignore 2019-05-21 10:11:44 -04:00
.prettierrc.json Add ESLint and Prettier tooling 2019-04-19 15:35:44 -04:00
LICENSE.md Add license files 2019-04-20 10:38:10 -04:00
README.md Fix numbering in README 2019-04-22 12:02:40 -04:00
jest.config.js Add working Jest & TypeScript config 2019-04-19 15:15:34 -04:00
lerna.json Initialize a Lerna project 2019-04-19 14:29:24 -04:00
package-lock.json Add concurrently and check-all script 2019-05-21 10:43:05 -04:00
package.json DRY up core tests 2019-05-21 11:23:35 -04:00
tsconfig.json Add ESLint 2019-05-21 10:34:23 -04:00

README.md

Actions Toolkit 🛠

Packages

Package Description
@actions/exit Provides utilities for exiting from an action
@actions/toolkit A general-purpose toolkit for writing actions

Development

This repository uses Lerna to manage multiple packages. Read the documentation there to begin contributing.

Useful Scripts

  • npm run bootstrap This runs lerna bootstrap which will install dependencies in this repository's packages and cross-link packages where necessary.
  • npm run build This compiles TypeScript code in each package (this is especially important if one package relies on changes in another when you're running tests). This is just an alias for lerna run tsc.
  • npm run format This checks that formatting has been applied with Prettier.
  • npm test This runs all Jest tests in all packages in this repository.
    • If you need to run tests for only one package, you can pass normal Jest CLI options: 
      $ npm test -- packages/toolkit
  • npm run create-package [name] This runs a script that automates a couple of parts of creating a new package.

Creating a Package

  1. In a new branch, create a new Lerna package:
$ npm run create-package new-package

This will ask you some questions about the new package. Start with 0.0.0 as the first version (look generally at some of the other packages for how the package.json is structured).

  1. Add tsc script to the new package's package.json file:
"scripts": {
  "tsc": "tsc"
}
  1. Start developing 😄 and open a pull request.