javascript-action-template

This template can be used to quickly start a new custom js action repository. Click the Use this template button at the top to get started.

Index

• javascript-action-template
  • Inputs
  • Outputs
  • Usage Examples
  • Contributing
    • Incrementing the Version
    • Source Code Changes
    • Recompiling Manually
    • Updating the README.md
    • Tests
  • Code of Conduct
  • License

TODOs

• README.md
  • Update the Inputs section with the correct action inputs
  • Update the Outputs section with the correct action outputs
  • Update the Usage Example section with the correct usage
• package.json
  • Update the name with the new action value
• src/main.js
  • Implement your custom javascript action
• action.yml
  • Fill in the correct name, description, inputs and outputs
• .prettierrc.json
  • Update any preferences you might have
• CODEOWNERS
  • Update as appropriate
• Repository Settings
  • On the Options tab check the box to Automatically delete head branches
  • On the Options tab update the repository's visibility (must be done by an org owner)
  • On the Branches tab add a branch protection rule
    • Check Require pull request reviews before merging
    • Check Dismiss stale pull request approvals when new commits are pushed
    • Check Require review from Code Owners
    • Check Require status checks to pass before merging
    • Check Require branches to be up to date before merging
    • Add build to the list of required status checks. This will need to be done after the first build workflow runs.
    • Check Do not allow bypassing the above settings
  • On the Manage Access tab add the appropriate groups
• About Section (accessed on the main page of the repo, click the gear icon to edit)
  • The repo should have a short description of what it is for
  • Add one of the following topic tags:

    Topic Tag	Usage
    az	For actions related to Azure
    code	For actions related to building code
    certs	For actions related to certificates
    db	For actions related to databases
    git	For actions related to Git
    iis	For actions related to IIS
    microsoft-teams	For actions related to Microsoft Teams
    svc	For actions related to Windows Services
    jira	For actions related to Jira
    meta	For actions related to running workflows
    pagerduty	For actions related to PagerDuty
    test	For actions related to testing
    tf	For actions related to Terraform

  • Add any additional topics for an action if they apply
  • The Packages and Environments boxes can be unchecked
• Search for any remaining TODOs and address them.

Inputs

Parameter	Is Required	Default	Description
input	true		Description goes here

Outputs

Output	Description	Possible Values
output	Description goes here

Usage Examples

jobs:
  jobname: # TODO: fix the job name
    runs-on: ubuntu-20.04
    steps:
      - uses: actions/checkout@v3

      - name: ''
        uses: im-open/[email protected] # TODO:  fix the action name
        with:
          input: ''

Contributing

When creating PRs, please review the following guidelines:

• The action code does not contain sensitive information.
• At least one of the commit messages contains the appropriate +semver: keywords listed under Incrementing the Version for major and minor increments.
• The action has been recompiled. See Recompiling Manually for details.
• The README.md has been updated with the latest version of the action. See Updating the README.md for details.
• Any tests in the build-and-review-pr workflow are passing

Incrementing the Version

This repo uses git-version-lite in its workflows to examine commit messages to determine whether to perform a major, minor or patch increment on merge if source code changes have been made. The following table provides the fragment that should be included in a commit message to active different increment strategies.

Increment Type	Commit Message Fragment
major	+semver:breaking
major	+semver:major
minor	+semver:feature
minor	+semver:minor
patch	default increment type, no comment needed

Source Code Changes

The files and directories that are considered source code are listed in the files-with-code and dirs-with-code arguments in both the build-and-review-pr and increment-version-on-merge workflows.

If a PR contains source code changes, the README.md should be updated with the latest action version and the action should be recompiled. The build-and-review-pr workflow will ensure these steps are performed when they are required. The workflow will provide instructions for completing these steps if the PR Author does not initially complete them.

If a PR consists solely of non-source code changes like changes to the README.md or workflows under ./.github/workflows, version updates and recompiles do not need to be performed.

Recompiling Manually

This command utilizes esbuild to bundle the action and its dependencies into a single file located in the dist folder. If changes are made to the action's source code, the action must be recompiled by running the following command:

# Installs dependencies and bundles the code
npm run build

Updating the README.md

If changes are made to the action's source code, the usage examples section of this file should be updated with the next version of the action. Each instance of this action should be updated. This helps users know what the latest tag is without having to navigate to the Tags page of the repository. See Incrementing the Version for details on how to determine what the next version will be or consult the first workflow run for the PR which will also calculate the next version.

Tests

The build and review PR workflow includes tests which are linked to a status check. That status check needs to succeed before a PR is merged to the default branch. When a PR comes from a branch, there should not be any issues running the tests. When a PR comes from a fork, tests may not have the required permissions or access to run since the GITHUB_TOKEN only has read access set for all scopes. Also, forks cannot access other secrets in the repository. In these scenarios, a fork may need to be merged into an intermediate branch by the repository owners to ensure the tests run successfully prior to merging to the default branch.

Code of Conduct

This project has adopted the im-open's Code of Conduct.

License

Copyright © 2023, Extend Health, LLC. Code released under the MIT license.