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.

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

Modifying README to include instructions/examples for directory functionality #183

Merged
merged 27 commits into from
Apr 12, 2022
Merged
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
9b38591
Added some tests, not sure what else to try but gonna think of more e…
Apr 7, 2022
60b9447
forgot some files
Apr 7, 2022
76ae52d
reverted package-lock.json
Apr 8, 2022
aa31882
Merge pull request #1 from jaiveerk/jkatariya/search-directories-for-…
jaiveerk Apr 8, 2022
555f911
Added empty dir test
Apr 8, 2022
cc1ee51
Merge pull request #2 from jaiveerk/jkatariya/search-directories-for-…
jaiveerk Apr 8, 2022
bcbf7bd
Cleaned up some extra spaces
Apr 8, 2022
097c4f0
Merge pull request #3 from jaiveerk/jkatariya/search-directories-for-…
jaiveerk Apr 8, 2022
2969e0c
Add node modules and compiled JavaScript from main
OliverMKing Apr 11, 2022
4a69b7b
Merge pull request #4 from jaiveerk/create-release
jaiveerk Apr 11, 2022
6b45548
Merge pull request #5 from jaiveerk/releases/v3.0.3
jaiveerk Apr 11, 2022
8332dd7
forgot to actually include functionality
Apr 11, 2022
0725e8e
Merge pull request #6 from jaiveerk/jkatariya/search-directories-for-…
jaiveerk Apr 11, 2022
12365f9
removed unnecessary files
Apr 12, 2022
6c3180d
Update .gitignore
jaiveerk Apr 12, 2022
3899333
Update .gitignore
jaiveerk Apr 12, 2022
7e0e8e1
Update .gitignore
jaiveerk Apr 12, 2022
be1058d
thx david
Apr 12, 2022
bcf2179
renamed searchFilesRec
Apr 12, 2022
bbaed40
integrations test fix
Apr 12, 2022
bb89113
Merge pull request #9 from jaiveerk/toMerge
jaiveerk Apr 12, 2022
086c91e
Merge branch 'Azure:main' into main
jaiveerk Apr 12, 2022
b4c507d
added examples to README
Apr 12, 2022
2a03ff2
added note about depth
Apr 12, 2022
920032e
added additional note
Apr 12, 2022
fd32814
removed ticks
Apr 12, 2022
824f370
changed version string
Apr 12, 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
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Following are the key capabilities of this action:
</tr>
<tr>
<td>manifests </br></br>(Required)</td>
<td>Path to the manifest files to be used for deployment</td>
<td>Path to the manifest files to be used for deployment. These can also be directories containing manifest files, in which case, all manifest files in the referenced directory at every depth will be deployed. Files not ending in .yml or .yaml will be ignored.</td>
</tr>
<tr>
<td>namespace </br></br>(Optional)
Expand Down Expand Up @@ -105,12 +105,11 @@ Following are the key capabilities of this action:
### Basic deployment (without any deployment strategy)

```yaml
- uses: Azure/k8s-deploy@v1.4
- uses: Azure/k8s-deploy@v3.1
with:
namespace: "myapp"
manifests: |
deployment.yaml
service.yaml
dir/manifestsDirectory
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
imagepullsecrets: |
image-pull-secret1
Expand All @@ -121,7 +120,7 @@ Following are the key capabilities of this action:
### Canary deployment without service mesh

```yaml
- uses: Azure/k8s-deploy@v1.4
- uses: Azure/k8s-deploy@v3.1
with:
namespace: "myapp"
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
Expand All @@ -131,6 +130,7 @@ Following are the key capabilities of this action:
manifests: |
deployment.yaml
service.yaml
dir/manifestsDirectory
strategy: canary
action: deploy
percentage: 20
Expand All @@ -139,7 +139,7 @@ Following are the key capabilities of this action:
To promote/reject the canary created by the above snippet, the following YAML snippet could be used:

```yaml
- uses: Azure/k8s-deploy@v1.4
- uses: Azure/k8s-deploy@v3.1
with:
namespace: "myapp"
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
Expand All @@ -149,14 +149,15 @@ To promote/reject the canary created by the above snippet, the following YAML sn
manifests: |
deployment.yaml
service.yaml
dir/manifestsDirectory
strategy: canary
action: promote # substitute reject if you want to reject
```

### Canary deployment based on Service Mesh Interface

```yaml
- uses: Azure/k8s-deploy@v1.4
- uses: Azure/k8s-deploy@v3.1
with:
namespace: "myapp"
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
Expand All @@ -166,6 +167,7 @@ To promote/reject the canary created by the above snippet, the following YAML sn
manifests: |
deployment.yaml
service.yaml
dir/manifestsDirectory
strategy: canary
action: deploy
traffic-split-method: smi
Expand All @@ -176,7 +178,7 @@ To promote/reject the canary created by the above snippet, the following YAML sn
To promote/reject the canary created by the above snippet, the following YAML snippet could be used:

```yaml
- uses: Azure/k8s-deploy@v1.4
- uses: Azure/k8s-deploy@v3.1
with:
namespace: "myapp"
images: "contoso.azurecr.io/myapp:${{ event.run_id }} "
Expand All @@ -186,6 +188,7 @@ To promote/reject the canary created by the above snippet, the following YAML sn
manifests: |
deployment.yaml
service.yaml
dir/manifestsDirectory
strategy: canary
traffic-split-method: smi
action: reject # substitute reject if you want to reject
Expand All @@ -194,7 +197,7 @@ To promote/reject the canary created by the above snippet, the following YAML sn
### Blue-Green deployment with different route methods

```yaml
- uses: Azure/k8s-deploy@v1.4
- uses: Azure/k8s-deploy@v3.1
with:
namespace: "myapp"
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
Expand All @@ -214,7 +217,7 @@ To promote/reject the canary created by the above snippet, the following YAML sn
To promote/reject the green workload created by the above snippet, the following YAML snippet could be used:

```yaml
- uses: Azure/k8s-deploy@v1.4
- uses: Azure/k8s-deploy@v3.1
with:
namespace: "myapp"
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
Expand All @@ -224,7 +227,7 @@ To promote/reject the green workload created by the above snippet, the following
manifests: |
deployment.yaml
service.yaml
ingress-yml
ingress.yml
strategy: blue-green
route-method: ingress # should be the same as the value when action was deploy
action: promote # substitute reject if you want to reject
Expand Down Expand Up @@ -271,7 +274,7 @@ jobs:
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
secret-name: demo-k8s-secret

- uses: Azure/k8s-deploy@v1.4
- uses: Azure/k8s-deploy@v3.1
with:
action: deploy
manifests: |
Expand Down Expand Up @@ -317,7 +320,7 @@ jobs:
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
secret-name: demo-k8s-secret

- uses: Azure/k8s-deploy@v1.4
- uses: Azure/k8s-deploy@v3.1
with:
action: deploy
manifests: |
Expand Down