You need to set some secrets before be able to run your pipeline:
- GITHUB: Github PAT Token from https://github.com/settings/tokens
- ELASTIC_HOST: url of your elastic instance
- ELASTIC_KEY_ID : generated from elastic API see ELK Documentation
- ELASTIC_API_KEY : generated from elastic API see ELK Documentation
Then add this to your workflow:
send-logs-to-elastic:
runs-on: ubuntu-latest
if: always()
steps:
- name: Upload GitHub Action workflows logs to elastic
uses: knutfr/github-actions-to-elk@v1.0.4
with:
githubToken: "${{ secrets.GITHUB }}"
githubOrg: "myOrg"
githubRepository: "myRepository"
githubRunId: "${{ github.run_id }}"
elasticHost: "${{ secrets.ELASTIC_HOST }}"
elasticApiKeyId: "${{ secrets.ELASTIC_KEY_ID }}"
elasticApiKey: "${{ secrets.ELASTIC_API_KEY }}"
elasticIndex: "github"
First, you'll need to have a reasonably modern version of
nodehandy. This won't work with versions older than 9, for instance.
Install the dependencies
$ yarn installBuild the typescript and package it for distribution
$ yarn run build && yarn run packageRun the tests ✔️
$ yarn test
PASS ./index.test.js
✓ throws invalid number (3ms)
✓ wait 500 ms (504ms)
✓ test runs (95ms)
...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
Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
import * as core from '@actions/core';
...
async function run() {
try {
...
}
catch (error) {
core.setFailed(error.message);
}
}
run()See the toolkit documentation for the various packages.
Actions are run from GitHub repos so we will checkin the packed dist folder.
Then run ncc and push the results:
$ npm run package
$ git add dist
$ git commit -a -m "prod dependencies"
$ git push origin releases/v1Note: 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! 🚀
See the versioning documentation
You can now validate the action by referencing ./ in a workflow in your repo (see test.yml)
uses: ./
with:
milliseconds: 1000See the actions tab for runs of this action! 🚀
After testing you can create a v1 tag to reference the stable and latest V1 action