https://github.com/brandonxiang/actions-docup

A github action for docup
https://github.com/brandonxiang/actions-docup

Last synced: 16 days ago
JSON representation

A github action for docup

• Host: GitHub
• URL: https://github.com/brandonxiang/actions-docup
• Owner: brandonxiang
• License: mit
• Created: 2022-10-17T08:06:23.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-07T11:08:45.000Z (over 1 year ago)
• Last Synced: 2024-10-11T12:58:25.533Z (about 1 month ago)
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/actions-docup
• Size: 289 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# Create a JavaScript Action



  



Use this template to bootstrap the creation of a JavaScript action.:rocket:

This template includes tests, linting, a validation workflow, publishing, and versioning guidance.

If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)

## Create an action from this template

Click the `Use this Template` and provide the new repo details for your action

## Code in Main

Install the dependencies

```bash

npm install

```

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 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

const core = require('@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.

## Package for distribution

GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.

Actions are run from GitHub repos.  Packaging the action will create a packaged action in the dist folder.

Run prepare

```bash

npm run prepare

```

Since the packaged index.js is run from the dist folder.

```bash

git add dist

```

## Create a release branch

Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions.

Checkin to the v1 release branch

```bash

git checkout -b v1

git commit -a -m "v1 release"

```

```bash

git push origin 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)

## Usage

You can now consume the action by referencing the v1 branch

```yaml

uses: actions/javascript-action@v1

with:

  milliseconds: 1000

```

See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket: