Skip to content

Update docs to state the default branch used as the source #418

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

Merged
sbkok merged 2 commits into from
Jan 7, 2022
Merged

Update docs to state the default branch used as the source #418

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
eb9b4ef
Update docs to state the default branch used as the source
sbkok Dec 31, 2021
6409455
Merge branch 'master' into docs/default-scm-branch
sbkok Jan 7, 2022
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 docs/admin-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ config:
keep-default-scp: enabled # Optional
scm: # Source Control Management
auto-create-repositories: enabled # Optional
default-scm-branch: master # Optional
default-scm-branch: main # Optional
```

In the above example the properties are categorized into `roles`, `regions`,
Expand Down
6 changes: 3 additions & 3 deletions docs/providers-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Provider type: `codecommit`.
> action to trigger the pipeline.
- *repository* - *(String)* defaults to name of the pipeline.
> The AWS CodeCommit repository name.
- *branch* - *(String)* default: `master`.
- *branch* - *(String)* default to configured [adfconfig.yml: config/scm/default-scm-branch](./admin-guide.md#adfconfig).
> The Branch on the CodeCommit repository to use to trigger this specific
> pipeline.
- *poll_for_changes* - *(Boolean)* default: `False`.
Expand Down Expand Up @@ -105,7 +105,7 @@ Provider type: `github`.
> The GitHub repository name.
> For example, for the ADF repository it would be:
> `aws-deployment-framework`.
- *branch* - *(String)* - default: `master`.
- *branch* - *(String)* default to configured [adfconfig.yml: config/scm/default-scm-branch](./admin-guide.md#adfconfig).
> The Branch on the GitHub repository to use to trigger this specific
> pipeline.
- *owner* - *(String)* **(required)**
Expand Down Expand Up @@ -181,7 +181,7 @@ Provider type: `codestar`.
> The CodeStar repository name.
> For example, for the ADF repository it would be:
> `aws-deployment-framework`.
- *branch* - *(String)* - default: `master`.
- *branch* - *(String)* default to configured [adfconfig.yml: config/scm/default-scm-branch](./admin-guide.md#adfconfig).
> The Branch on the third-party repository to use to trigger this specific
> pipeline.
- *owner* - *(String)* **(required)**
Expand Down