diff --git a/README.md b/README.md index a0b5da2..de68095 100644 --- a/README.md +++ b/README.md @@ -1,105 +1,23 @@ -

- typescript-action status -

+# Calculate Deployment Name Action -# Create a JavaScript Action using TypeScript +Github Action to unify and centralize calculating deployment names for all +github actions. -Use this template to bootstrap the creation of a TypeScript action.:rocket: -This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance. +## Motivation -If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action) +To prevent every author of every application that uses github actions, to copy +the line where we calculate the deployment name across several files, we decided +to use a centralized approach, so all applications will work with the same +pattern of deployment names, no matter what stack they're written in. -## Create an action from this template +## Usage -Click the `Use this Template` and provide the new repo details for your action - -## Code in Main - -> 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 -$ yarn install -``` - -Build the typescript and package it for distribution -```bash -$ yarn build && yarn package -``` - -Run the tests :heavy_check_mark: -```bash -$ yarn 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 -$ yarn 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)) +Basic: ```yaml -uses: ./ -with: - milliseconds: 1000 +- uses: localsearch/calculate-deployment-name-action@v1 + with: + app: ${{github.event.repository.name}} + branch: ${{ github.head_ref }} ``` - -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