1
0
Fork 0
 
 
 
Go to file
Brian Cristante 91b7bf978c
Move @actions/http-client into the toolkit (#1062)
💡 See https://github.com/actions/toolkit/pull/1064 for a better diff!

https://github.com/actions/toolkit contains a variety of packages used for building actions.  https://github.com/actions/http-client is one such package, but lives outside of the toolkit.  Moving it inside of the toolkit will improve discoverability and reduce the number of repos we have to keep track of for maintenance tasks (such as github/c2c-actions-service#2937).

I checked with @bryanmacfarlane on the historical decision here.  Apparently it was just inertia from before we released the toolkit as multiple packages.

The benefits here are:
- Have one fewer repo to keep track of
- Signal that this is an HTTP client meant for building actions, not for general use.

## Notes
- `@actions/http-client` will continue to be released as its own package.
- Bumping the package version to **2.0.0**.  Since we're compiling in strict mode now, there are some breaking changes to the exported types.  This is an improvement because the null-unsafe version of`http-client` is currently breaking the safety of null-safe consumers.
- I'm not updating the other packages to use the new version in this PR.  I plan to do that in a follow-up.  We'll hold off on publishing `http-client` v2 to NPM until that's done just in case other changes shake out of it.
2022-05-03 11:10:13 -04:00
.github Move @actions/http-client into the toolkit (#1062) 2022-05-03 11:10:13 -04:00
docs Add notice annotation and support more annotation fields (#855) 2021-07-28 17:34:31 -04:00
packages Move @actions/http-client into the toolkit (#1062) 2022-05-03 11:10:13 -04:00
res add logo (#27) 2019-07-10 14:02:56 -04:00
scripts Move @actions/http-client into the toolkit (#1062) 2022-05-03 11:10:13 -04:00
.eslintignore Re-enable the audit tools step and update dependencies (#815) 2021-05-21 09:19:40 -04:00
.eslintrc.json Re-enable the audit tools step and update dependencies (#815) 2021-05-21 09:19:40 -04:00
.gitignore tool-cache: Support for extracting xar compatible archives (#207) 2020-07-15 14:49:23 -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
CODEOWNERS Update CODEOWNERS with new teams (#990) 2022-02-02 12:43:38 -05:00
CODE_OF_CONDUCT.md updating readmes 2019-10-09 08:47:27 -04:00
LICENSE.md Add License.md to all npm packages (#548) 2020-08-25 16:26:50 -04:00
README.md Move @actions/http-client into the toolkit (#1062) 2022-05-03 11:10:13 -04:00
SECURITY.md updating readmes 2019-10-09 08:47:27 -04:00
jest.config.js Update High Severity Dev Dependencies (#923) 2021-10-14 09:20:09 -04:00
lerna.json Initialize a Lerna project 2019-04-19 14:29:24 -04:00
package-lock.json Fix npm audit (#1040) 2022-03-31 14:40:06 -04:00
package.json Update High Severity Dev Dependencies (#923) 2021-10-14 09:20:09 -04:00
tsconfig.eslint.json Update eslint to 2.2.7 (#410) 2020-04-13 10:19:49 -04:00
tsconfig.json @actions/artifact 0.5.1 release (#760) 2021-04-06 12:44:56 -04:00

README.md

Toolkit unit tests status Toolkit audit status

GitHub Actions Toolkit

The GitHub Actions ToolKit provides a set of packages to make creating actions easier.


Get started with the javascript-action template!


Packages

✔️ @actions/core

Provides functions for inputs, outputs, results, logging, secrets and variables. Read more here

$ npm install @actions/core

🏃 @actions/exec

Provides functions to exec cli tools and process output. Read more here

$ npm install @actions/exec

🍨 @actions/glob

Provides functions to search for files matching glob patterns. Read more here

$ npm install @actions/glob

☎️ @actions/http-client

A lightweight HTTP client optimized for building actions. Read more here

$ npm install @actions/http-client

✏️ @actions/io

Provides disk i/o functions like cp, mv, rmRF, which etc. Read more here

$ npm install @actions/io

🔨 @actions/tool-cache

Provides functions for downloading and caching tools. e.g. setup-* actions. Read more here

See @actions/cache for caching workflow dependencies.

$ npm install @actions/tool-cache

:octocat: @actions/github

Provides an Octokit client hydrated with the context that the current action is being run in. Read more here

$ npm install @actions/github

💾 @actions/artifact

Provides functions to interact with actions artifacts. Read more here

$ npm install @actions/artifact

🎯 @actions/cache

Provides functions to cache dependencies and build outputs to improve workflow execution time. Read more here

$ npm install @actions/cache

Creating an Action with the Toolkit

Choosing an action type

Outlines the differences and why you would want to create a JavaScript or a container based action.

Versioning

Actions are downloaded and run from the GitHub graph of repos. This contains guidance for versioning actions and safe releases.

⚠️ Problem Matchers

Problem Matchers are a way to scan the output of actions for a specified regex pattern and surface that information prominently in the UI.

⚠️ Proxy Server Support

Self-hosted runners can be configured to run behind proxy servers.

Hello World JavaScript Action

Illustrates how to create a simple hello world javascript action.

...
  const nameToGreet = core.getInput('who-to-greet');
  console.log(`Hello ${nameToGreet}!`);
...

JavaScript Action Walkthrough

Walkthrough and template for creating a JavaScript Action with tests, linting, workflow, publishing, and versioning.

async function run() {
  try {
    const ms = core.getInput('milliseconds');
    console.log(`Waiting ${ms} milliseconds ...`)
    ...
PASS ./index.test.js
   throws invalid number
   wait 500 ms
   test runs

Test Suites: 1 passed, 1 total
Tests:       3 passed, 3 total

TypeScript Action Walkthrough

Walkthrough creating a TypeScript Action with compilation, tests, linting, workflow, publishing, and versioning.

import * as core from '@actions/core';

async function run() {
  try {
    const ms = core.getInput('milliseconds');
    console.log(`Waiting ${ms} milliseconds ...`)
    ...
PASS ./index.test.js
   throws invalid number
   wait 500 ms
   test runs

Test Suites: 1 passed, 1 total
Tests:       3 passed, 3 total


Docker Action Walkthrough

Create an action that is delivered as a container and run with docker.

FROM alpine:3.10
COPY LICENSE README.md /
COPY entrypoint.sh /entrypoint.sh
ENTRYPOINT ["/entrypoint.sh"]

Docker Action Walkthrough with Octokit

Create an action that is delivered as a container which uses the toolkit. This example uses the GitHub context to construct an Octokit client.

FROM node:slim
COPY . .
RUN npm install --production
ENTRYPOINT ["node", "/lib/main.js"]
const myInput = core.getInput('myInput');
core.debug(`Hello ${myInput} from inside a container`);

const context = github.context;
console.log(`We can even get context data, like the repo: ${context.repo.repo}`)

Contributing

We welcome contributions. See how to contribute.

Code of Conduct

See our code of conduct.