generated from actions/javascript-action
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
9 additions
and
107 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,114 +1,16 @@ | ||
| # HTML Preview Action | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/actions/javascript-action/actions"><img alt="javscript-action status" src="https://github.com/actions/javascript-action/workflows/units-test/badge.svg"></a> | ||
| </p> | ||
| This is a simple Github Action which comments on your PRs with a link to preview HTML files directly in the browser. | ||
|
|
||
| # 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 Master | ||
|
|
||
| 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 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 | ||
| 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 package | ||
|
|
||
| ```bash | ||
| npm run package | ||
| ``` | ||
|
|
||
| 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 | ||
| ``` | ||
|
|
||
| Your action is now published! :rocket: | ||
|
|
||
| See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) | ||
| This is just a novelty action, but feel free to use it. If you'd like to contribute then just open a PR. | ||
|
|
||
| ## Usage | ||
|
|
||
| You can now consume the action by referencing the v1 branch | ||
|
|
||
| ```yaml | ||
| uses: actions/javascript-action@v1 | ||
| with: | ||
| milliseconds: 1000 | ||
| - name: HTML Preview | ||
| uses: pavi2410/html-preview-action@master | ||
| with: | ||
| msg: 'Click here to preview HTML page in browser' | ||
| html_file: 'index.html' | ||
| gh_token: ${{ secrets.GITHUB_TOKEN }} | ||
| ``` | ||
| See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket: |