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
  • Recompiling
  • Incrementing the Version
• 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 please ensure:

1. For major or minor changes, at least one of the commit messages contains the appropriate +semver: keywords listed under Incrementing the Version.
2. The action code does not contain sensitive information.

When a pull request is created and there are changes to code-specific files and folders, the build workflow will run and it will recompile the action and push a commit to the branch if the PR author has not done so. The usage examples in the README.md will also be updated with the next version if they have not been updated manually. The following files and folders contain action code and will trigger the automatic updates:

• action.yml
• package.json
• package-lock.json
• src/**
• dist/**

There may be some instances where the bot does not have permission to push changes back to the branch though so these steps should be done manually for those branches. See Recompiling Manually and Incrementing the Version for more details.

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.

Both the build and PR merge workflows will use the strategies below to determine what the next version will be. If the build workflow was not able to automatically update the README.md action examples with the next version, the README.md should be updated manually as part of the PR using that calculated version.

This action uses git-version-lite 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.

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

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