Nothing Special   »   [go: up one dir, main page]

Skip to content

actionforge/vscode-ext

Repository files navigation

Actionforge VS Code Extension

Welcome to the source code of the Actionforge VS Code Extension

Actionforge VS Code Extension logo

view-action-graph made-with-ts License

Actionforge supercharges your GitHub Actions workflow experience in VS Code. Designed for time saving, this extension integrates seamlessly into your coding environment, offering a suite of tools to help you manage your GitHub Actions workflows. Whether you're a beginner or a seasoned developer, Actionforge helps set up your workflows within minutes, not hours. You can finally say good bye to tedious editing of YAML files.

Graph Editor Screenshot

Video Tutorial

Create your first workflow

The easiest way to create a workflow is to use the command called Create a new action graph for GitHub Actions workflow.

VS Code Extension Command

Select a name for your workflow and press Enter.

VS Code Extension Command

The extension will now create two files, a workflow file and an action graph file.

VS Code Extension Command

Why two files?

In order to use an action graph in your workflow, Actionforge needs two files.

The first one is a traditional GitHub Action workflow with a single step that runs the actionforge/action action. Here is an example file of

my-workflow.yml

on: [push]

jobs:
    build-and-publish:
      runs-on: ubuntu-latest
      name: My workflow
      steps:
        - name: Execute Action Graph
          uses: actionforge/action@1cb7c397d2c7caa8d8071041976b6f2e4e2ead20  # v0.9.58
          with:
            graph_file: my-workflow.yml

            # Uncomment to use secrets within the action graph.
            # secrets: ${{ toJson(secrets) }}

            # Uncomment to pass inputs from a 'workflow_dispatch' event.
            # inputs: ${{ toJson(inputs) }}

            # Uncomment to access values set by the matrix strategy.
            # matrix: ${{ toJson(matrix) }}

The second one is the action graph itself. This is a YAML file that you can edit via the graph editor that is part of this extension.

Add third-party GitHub Actions to your workflow

In order to add GitHub Actions to the node list, visit the VS Code Marketplace.

1) Select a version

Select the version you want to use, usually the latest version. Click on the green button.

Load GH Action Step 1

2) Copy

Coy the snippet below to the clipboard.

Load GH Action Step 2

3) Paste

Paste the snippet into the text field of the graph editor and click on the Load GitHub Action button.

Load GH Action Step 3

After the action has been loaded, you can create a new node.

License

This SOFTWARE is licensed under the Actionforge Community License that you can find here.

Licenses for commercial use will soon be available on the GitHub Marketplace.

For further information Get in touch.