Skip to content

Commit

Permalink
Merge pull request #439 from BenStreet365/main
Browse files Browse the repository at this point in the history
Adjust documentation for GitHub Action workflow creation + grammar correction in action.yml
  • Loading branch information
merill committed Sep 3, 2024
2 parents 54817ee + 3d8bc70 commit 05a0357
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ inputs:
default: true
artifact_upload:
type: boolean
description: "Define whether the results are uploaded as Artifacts"
description: "Define whether the results are uploaded as Artifacts."
required: false
default: true

Expand Down
19 changes: 18 additions & 1 deletion website/docs/monitoring/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,20 @@ GitHub is the quickest and easiest way to get started with automating Maester. T

- If you are new to GitHub, create an account at [github.com](https://github.com/join)

### Create a new repository and import the Maester Tests repository
## Use the latest, or keep control of your versions?

You may want to always use the latest, or you may want to control the tests running each time. The two options below provide a choice for each.

### 1. Create a blank new repository to always use the latest available public Maester Tests

- Open [https://github.com/new](https://github.com/new)
- Fill in the following fields:
- **Repository name**: E.g. `maester-tests`
- **Add a README file**: Select this option to initialize your repository
- **Private**: Select this option to keep your tests private
- Select **Create repository**

### 2. Create a new repository and import the Maester Tests repository, to keep updated yourself

- Open [https://github.com/new/import](https://github.com/new/import)
- Fill in the following fields:
Expand Down Expand Up @@ -104,6 +117,10 @@ jobs:
with:
client_id: ${{ secrets.AZURE_CLIENT_ID }}
tenant_id: ${{ secrets.AZURE_TENANT_ID }}
include_public_tests: true # Optional: Set to false if you are keeping to a certain version of tests or have your own tests
step_summary: true # Optional: Set to false if you don't want a summary added to your GitHub Action run
artifact_upload: true # Optional: Set to false if you don't want summaries uploaded to GitHub Artifacts
# Other inputs are available and can be reviewed in the action.yml in the Maester repository

```

Expand Down

0 comments on commit 05a0357

Please sign in to comment.