README.md

.github

Workflows

The following workflows are for the entire JupiterOne organization.

General Workflows

• provision_only_pr
• provision_only_release

Frontend Workflows

Runtime

• frontend_runtime_application_pr
• frontend_runtime_application_manual_e2e_run
• frontend_runtime_utility_pr
• frontend_runtime_utility_manual_e2e_trigger
• frontend_runtime_deploy

NPM Packages

• frontend_npm_pr
• frontend_npm_release

Backend Workflows

• publish_docker_ghcr
• publish_integration_docker_image

Composite Actions

The workflows above take advantage of the composite actions listed below, leveraging composition to execute those jobs that pertain to the workflow. The actions below enable us to consolidate repeatable jobs into a single location. This makes our workflows DRY, easier to reason about and more stable.

Common

• validate
• build
• get_branch
• pr_comment
• setup_env
• version_artifact

Frontend

Common

• chromatic
• cortex

Runtime

• e2e_pending_status
• e2e_prepare
• e2e_run
• e2e_status
• e2e_trigger_remote_tests
• magic_url
• migration_number
• remote_types_install
• remote_types_tests

NPM Packages

• publish

Local Testing

We are using act-js and mock-github to test our workflows and composite actions. These tests are intended to simplify development, speed up the feedback loop, and bring more stability to our flows and actions. To run the tests, please execute the following command:

npm test

Enable Logging

The following produces a log file called [name].log in the repo directory.

ACT_LOG=true npm test

Strategy

Skipping Steps

Many of our steps cannot and should not be run during testing (installing npm packages, running cypress, etc.) and would break if we were to run them locally. To address this issue, you can define a mocks.ts file in your composite actions. This file should define the list of steps in your action that should be skipped during testing:

// .github/actions/frontend/chromatic/mocks.ts
export const CHROMATIC_MOCK_STEPS = [
  { name: 'chromatic_upload' },
  { name: 'chromatic_publish' },
];

When necessary you can also pass in mockSteps via the runWorkflow or runCompositeAction commands.

Mock composite action via runCompositeAction

const results = await runCompositeAction({ act, repoName, mockGithub, mockSteps: {
  { name: 'chromatic_upload' },
  { name: 'chromatic_publish' },
}});

Mock entire composite action via runWorkflow

const results = await runWorkflow({ act, repoName, mockGithub, mockSteps: {
  chromatic_upload_job: [
    {
      // Mocks the entire composite action
      name: 'chromatic_upload',
      mockWith: `echo "hello world"`,
    }
  ],
}});

Mock individual steps of composite action via runWorkflow

const results = await runWorkflow({ act, repoName, mockGithub, mockSteps: {
  chromatic_upload_job: [
    {
      // Mocking the individual steps in a composite action
      name: 'chromatic_upload',
      mockCompositeSteps:  [
        { name: 'chromatic_upload' },
        { name: 'chromatic_publish' },
      ]
    }
  ],
}});

Mapping Workflow Inputs To Composite Actions

As workflows grow over time, they may end up with a considerable number of inputs. We want to make sure those inputs get mapped to the correct composite actions. This is accomplished using the following approach.

If a composite action leverages inputs, you will see one its first steps has a name of [name]_inputs (example). This step is responsible for logging out the various inputs that are being passed to the action.

Then in our tests we are able to target these inputs and verify that the appropriate inputs are being mapped to the correct composite actions.

const test_inputs = getTestResult({ results, name: 'test_inputs' });

expect(test_inputs.output).toContain(`example_input=hello world`);

Composite Actions

When it comes to testing a composite action, you will notice the action has a test directory containing at least two files:

• test/action_test.yml - A composite action can not be triggered by itself like a workflow. This is a workflow file that utilizes the composition action (example).
• test/action.test.ts - This is the test itself that calls action_test.yml.

Note: You must ensure that name of the job and the path within in the action_test.yml match the repoName defined in the action.test.ts, otherwise the test will fail.

Note: All booleans in a composite action must leverage fromJSON to ensure the value are treated as booleans and not strings. See issue here: actions/runner#1483

Testing In Another Repo

If you wish to copy/paste the workflows and/or composite actions into another repo to test these out live, you can leverage the following command. This will create a temp directory with the workflows/actions in it. These will have been updated to:

• The uses property in the workflows will reference local composite actions - jupiterone/.github/.github/actions/.../@v# updated to ./.github/actions/...
• Test/readme files will also be dropped as these can cause issues.

npm run generate-local-files