-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
A GitHub Action to create GitHub Deployments, which serve as a trigger for a `deployment` workflow to actually deploy the specified commit. It can operate explicitly, by specifying the arguments declared in [`action.yml`](./action.yml), or implicitly where the action determines which deployments to create depending on the event which triggered it. - in case of a `push` event on the master branch; create single production deployment and create staging deployment for each staging environment label which doesn't have an open PR assigned. - in the case of a `pull_request` event; check the Pull Request for labels and create staging deployment for each matching label.
- Loading branch information
Showing
14 changed files
with
6,936 additions
and
762 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,105 +1,28 @@ | ||
<p align="center"> | ||
<a href="https://github.com/actions/typescript-action/actions"><img alt="typescript-action status" src="https://github.com/actions/typescript-action/workflows/build-test/badge.svg"></a> | ||
</p> | ||
# `trigger-deploy` | ||
|
||
# Create a JavaScript Action using TypeScript | ||
A GitHub Action to create GitHub Deployments, which serve as a trigger for a `deployment` workflow to actually | ||
deploy the specified commit. | ||
|
||
Use this template to bootstrap the creation of a TypeScript action.:rocket: | ||
It can operate explicitly, by specifying the arguments declared in [`action.yml`](./action.yml), or implicitly | ||
where the action determines which deployments to create depending on the event which triggered it. | ||
|
||
This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance. | ||
- in case of a `push` event on the master branch; create single production deployment and create staging | ||
deployment for each staging environment label which doesn't have an open PR assigned. | ||
- in the case of a `pull_request` event; check the Pull Request for labels and create staging deployment for each | ||
matching label. | ||
|
||
If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action) | ||
## Getting Started | ||
|
||
## Create an action from this template | ||
This is a TypeScript project, but GitHub Actions must be JavaScript so we also commit the compiled Javascript | ||
package. Before committing run the following, and commit the `dist` folder: | ||
|
||
Click the `Use this Template` and provide the new repo details for your action | ||
npm run all | ||
|
||
## Code in Main | ||
This runs the following commands, which can also be run independently: | ||
|
||
> First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance. | ||
Install the dependencies | ||
```bash | ||
$ npm install | ||
``` | ||
|
||
Build the typescript and package it for distribution | ||
```bash | ||
$ npm run build && npm run package | ||
``` | ||
|
||
Run the tests :heavy_check_mark: | ||
```bash | ||
$ npm test | ||
|
||
PASS ./index.test.js | ||
✓ throws invalid number (3ms) | ||
✓ wait 500 ms (504ms) | ||
✓ test runs (95ms) | ||
|
||
... | ||
``` | ||
|
||
## Change action.yml | ||
|
||
The action.yml contains defines the inputs and output for your action. | ||
|
||
Update the action.yml with your name, description, inputs and outputs for your action. | ||
|
||
See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions) | ||
|
||
## Change the Code | ||
|
||
Most toolkit and CI/CD operations involve async operations so the action is run in an async function. | ||
|
||
```javascript | ||
import * as core from '@actions/core'; | ||
... | ||
|
||
async function run() { | ||
try { | ||
... | ||
} | ||
catch (error) { | ||
core.setFailed(error.message); | ||
} | ||
} | ||
|
||
run() | ||
``` | ||
|
||
See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages. | ||
|
||
## Publish to a distribution branch | ||
|
||
Actions are run from GitHub repos so we will checkin the packed dist folder. | ||
|
||
Then run [ncc](https://github.com/zeit/ncc) and push the results: | ||
```bash | ||
$ npm run package | ||
$ git add dist | ||
$ git commit -a -m "prod dependencies" | ||
$ git push origin releases/v1 | ||
``` | ||
|
||
Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project. | ||
|
||
Your action is now published! :rocket: | ||
|
||
See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) | ||
|
||
## Validate | ||
|
||
You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml)) | ||
|
||
```yaml | ||
uses: ./ | ||
with: | ||
milliseconds: 1000 | ||
``` | ||
See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket: | ||
## Usage: | ||
After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action | ||
- `npm run build` - compile TypeScript | ||
- `npm run format` - format source | ||
- `npm run lint` - lint source | ||
- `npm run package` - compile a module into a single file | ||
- `npm test` - run tests | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.