Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 1.8 KB

README.md

File metadata and controls

60 lines (40 loc) · 1.8 KB
Raw

Akka CLI for GitHub Actions

This JavaScript action for GitHub workflows installs and configures the Akka CLI tool. After running this action, the akka command is available in the workflow.

Usage

The action takes two required parameters to authenticate and set the Akka project ID:

  • token: The Akka authentication token
  • project-id: The Akka project ID you're using

Example Workflow

The below flow shows how to use this action to list all services in your project

name: akka

on: 
  push:
    branches: [ main ]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Install Akka CLI
        uses: akka/setup-akka-cli-action@v1
        with:
          token: ${{ secrets.AKKA_TOKEN }}
          project-id: ${{ vars.AKKA_PROJECT_ID }}
      - name: List services
        run: akka service list

Building and developing

Follow the instructions to build and push the action.

  • run npm i --target_arch=x64 --target_platform=linux
  • update index.js file with your changes
  • run ncc build index.js
  • commit sources and dist folder

Contributing

We welcome all contributions! Pull requests are the preferred way to share your contributions. For major changes, please open an issue first to discuss what you would like to change.

Support

This project is an incubator

License

See the LICENSE