-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
2 changed files
with
11 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,7 +29,7 @@ More details on context, usage, troubleshooting or known issues and limitations | |
- [Tests](#tests) | ||
- [Code of Conduct](#code-of-conduct) | ||
- [License](#license) | ||
|
||
## Inputs | ||
|
||
| Parameter | Is Required | Description | | ||
|
@@ -70,37 +70,37 @@ The `validation-error` output will only contain one validation error at a time. | |
```yml | ||
name: Map project versions | ||
on: workflow_dispatch | ||
env: | ||
env: | ||
# These ENV variables contain the value of the private key | ||
# They can be set at the workflow, job or step level | ||
SSH_KEY_CENTRAL_LOGGING: ${{secrets.SSH_CENTRAL_LOGGING}} | ||
SSH_KEY_STORAGE_ACCOUNT: ${{secrets.SSH_STORAGE_ACCOUNT}} | ||
SSH_KEY_ON_PREM_EGRESS: ${{secrets.SSH_ON_PREM_EGRESS}} | ||
SSH_KEY_ON_PREM_EGRESS: ${{secrets.SSH_ON_PREM_EGRESS}} | ||
|
||
jobs: | ||
deploy-terraform: | ||
runs-on: ubuntu-20.04 | ||
steps: | ||
- name: Checkout Repository | ||
uses: actions/checkout@v3 | ||
uses: actions/checkout@v4 | ||
|
||
- name: Setup deploy keys for use with Terraform | ||
# You may also reference just the major or major.minor version | ||
uses: im-open/setup-deploy-keys@v1.1.4 | ||
uses: im-open/setup-deploy-keys@v1.2.0 | ||
with: | ||
deploy-key-info: | | ||
[ | ||
{ "orgAndRepo": "im-platform/central-logging", "envName" : "SSH_KEY_CENTRAL_LOGGING" }, | ||
{ "orgAndRepo": "im-platform/storage-account-network-rules", "envName" : "SSH_KEY_STORAGE_ACCOUNT" }, | ||
{ "orgAndRepo": "im-platform/on-prem-egress-ips", "envName" : "SSH_KEY_ON_PREM_EGRESS" } | ||
] | ||
- name: Setup Terraform | ||
id: setup | ||
uses: hashicorp/[email protected] | ||
with: | ||
terraform_version: ~>0.15.0 | ||
|
||
- name: Terraform Init | ||
id: init | ||
run: terraform init | ||
|
@@ -130,7 +130,7 @@ This repo uses [git-version-lite] in its workflows to examine commit messages to | |
|
||
### Source Code Changes | ||
|
||
The files and directories that are considered source code are listed in the `files-with-code` and `dirs-with-code` arguments in both the [build-and-review-pr] and [increment-version-on-merge] workflows. | ||
The files and directories that are considered source code are listed in the `files-with-code` and `dirs-with-code` arguments in both the [build-and-review-pr] and [increment-version-on-merge] workflows. | ||
|
||
If a PR contains source code changes, the README.md should be updated with the latest action version and the action should be recompiled. The [build-and-review-pr] workflow will ensure these steps are performed when they are required. The workflow will provide instructions for completing these steps if the PR Author does not initially complete them. | ||
|
||
|
@@ -151,7 +151,7 @@ If changes are made to the action's [source code], the [usage examples] section | |
|
||
### Tests | ||
|
||
The [build-and-review-pr] workflow includes tests which are linked to a status check. That status check needs to succeed before a PR is merged to the default branch. When a PR comes from a branch, the workflow has access to secrets which are required to run the tests successfully. | ||
The [build-and-review-pr] workflow includes tests which are linked to a status check. That status check needs to succeed before a PR is merged to the default branch. When a PR comes from a branch, the workflow has access to secrets which are required to run the tests successfully. | ||
|
||
When a PR comes from a fork, the workflow cannot access any secrets, so the tests won't have the necessary permissions to run. When a PR comes from a fork, the changes should be reviewed, then merged into an intermediate branch by repository owners so tests can be run against the PR changes. Once the tests have passed, changes can be merged into the default branch. | ||
|
||
|