Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adjust documentation for GitHub Action workflow creation + grammar correction in action.yml #439

Merged
merged 2 commits into from
Sep 3, 2024
Merged

Adjust documentation for GitHub Action workflow creation + grammar correction in action.yml #439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
426b3e9
Update github.md
BenStreet365 Aug 30, 2024
3d8bc70
Grammar correction
BenStreet365 Aug 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion action.yml
View file
Open in desktop
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
View file
Open in desktop
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
Loading