microsoft / action-armttk

Github Action for running ARM-TTK

action-armttk - Preview/In-Progress

This repo contains a action to run armttk.

Quick Start

Use this predefined workflow to quickly get started using this GitHub Action.

name: On pull request

on:
  pull_request:
    branches:
      - main

jobs:
  validate-module-files-with-armttk:
    uses: microsoft/action-armttk/.github/workflows/[email protected]
    with:
      bicepFile: main.bicep
      workingPath: .

Input

inputs:
  github_token:
    description: "GITHUB_TOKEN"
    required: true
    default: "${{ github.token }}"
  workdir:
    description: "Working directory relative to the root directory."
    required: false
    default: "."
  glob_pattern:
    description: "Glob pattern of the files to lint"
    required: false
    default: "."
  ### Flags for reviewdog ###
  tool_name:
    description: "Tool name to use for reviewdog reporter."
    required: false
    default: "armttk"
  level:
    description: "Report level for reviewdog [info,warning,error]"
    required: false
    default: "error"
  reporter:
    description: "Reporter of reviewdog command [github-pr-check,github-pr-review]."
    required: false
    default: "github-pr-check"
  filter_mode:
    description: |
      Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
      Default is added.
    required: false
    default: "added"
  fail_on_error:
    description: |
      Exit code for reviewdog when errors are found [true,false]
      Default is `false`.
    required: false
    default: "false"
  reviewdog_flags:
    description: "Additional reviewdog flags"
    required: false
    default: ""
  armttkVersion:
    description: latest or marketplace version of ARM-TTK 

Usage

name: reviewdog
on: [pull_request]
jobs:
  armttk:
    name: runner / armttk
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: microsoft/action-armttk@v1
        with:
          github_token: ${{ secrets.github_token }}
          # Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review].
          reporter: github-pr-review
          # Change reporter level if you need.
          # GitHub Status Check won't become failure with warning.
          level: warning
          glob_pattern: "**/*.json"

Development

Release

haya14busa/action-bumpr

You can bump version on merging Pull Requests with specific labels (bump:major,bump:minor,bump:patch). Pushing tag manually by yourself also work.

haya14busa/action-update-semver

This action updates major/minor release tags on a tag push. e.g. Update v1 and v1.2 tag when released v1.2.3. ref: https://help.github.com/en/articles/about-actions#versioning-your-action

Lint - reviewdog integration

This reviewdog action template itself is integrated with reviewdog to run lints which is useful for Docker container based actions.

Supported linters:

• reviewdog/action-shellcheck
• reviewdog/action-hadolint
• reviewdog/action-misspell

Dependencies Update Automation

This repository uses reviewdog/action-depup to update reviewdog version.

action-armttk's Issues

Link to TTK is broken in description

https://github.com/Azure/arm-ttk

Appears to be using an older version of TTK

Fails on Context AllAzureResources.cache.json->all

Hi i keep getting a failure in this section, is this meant to be running against that file?. ( Context AllAzureResources.cache.json->all
)

If we run the TTK locally on a copy of the repo then everything passes it's only when ran as an action that we get a failure and it's on.

This error. I've tried changing the location param in multiple places in the UI and azuredeploy to no avail.

Is the TTK calling against itself and failing?> Or am i misunderstanding what's going on with the CreateUIDefinition/Outputs-Must-Be-Present-In-Template-Parameters.test.ps1 when deployed in an action.

Any help would be appreciated as 125 commits later i can't resolve this :D

Add number of days to retain ARM-TTK results

The results of the ARM-TTK are uploaded to the GitHub artifactory.
I want to add a new parameter to control the number of days this report will saved in the artifactory.
In our company there is limited artifactory and we need to clean old files from it.
The suggestion is to add a new parameter:

  armttkResultsRetention:
    description: "Number of days to retain ARM-TTK results"
    required: false
    default: 30

And use it in the Publish Test Results step:

    - name: Publish Test Results
      uses: actions/upload-artifact@v3
      with:
        name: ARMTTKResults
        path: ./armttk.xml
        retention-days: ${{ inputs.armttkResultsRetention }}

I can open a new PR if you give me permission to do so.