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.

• Inputs
• Outputs
• Usage Examples
• Contributing
  • Incrementing the Version
  • Recompiling Manually
  • Updating the README.md
• Code of Conduct
• License

• 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.

jobs: jobname: # TODO: fix the job name runs-on: ubuntu-20.04 steps: - uses: actions/checkout@v3 - name: '' uses: im-open/thisrepo@v1.0.0 # TODO: fix the action name with: input: ''

When creating new PRs from a fork please review the following items:

* When a pull request is created from a branch, the build workflow will automatically recompile the action, update the README.md with the next version and push a commit to the branch if those changes have not already been made.

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

If a contributor is unsure what the next version will be, create a PR and the first build workflow that runs will calculate the value.

If changes are made to the action's code in this repository, or its dependencies, the action can be re-compiled by running the following command:

# Installs dependencies and bundles the code npm run build # Bundle the code (if dependencies are already installed) npm run bundle

These commands utilize esbuild to bundle the action and its dependencies into a single file located in the dist folder.

This step does not need to be completed if only ancillary files like the README.md have been changed.

If a pull request is made from a branch, this step will be automatically performed by the build workflow unless the PR author has already done so. Pull requests made from forked repositories will need to perform this step manually.

If changes are made to the action's source code, the README.md file should be updated to reflect the next version of the action. Each instance of the action in the examples should be updated. This helps users know what the latest tag is without having to navigate to the Tags page of the repository.

This step does not need to be completed if only ancillary files like the README.md have been changed.

If a pull request is made from a branch, this step will be automatically performed by the build workflow unless the PR author has already done so. Pull requests made from forked repositories will need to perform this step manually. See Incrementing the Version for details on how to determine what the next version will be.

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

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