Skip to content

Commit

Permalink
update to GH action to v2
Browse files Browse the repository at this point in the history
  • Loading branch information
vim-zz committed May 22, 2024
1 parent ca15f36 commit d64b4eb
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/downloads/gitstream.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
name: gitStream workflow automation
steps:
- name: Evaluate Rules
uses: linear-b/gitstream-github-action@v1
uses: linear-b/gitstream-github-action@v2
id: rules-engine
with:
full_repository: ${{ github.event.inputs.full_repository }}
Expand Down
2 changes: 1 addition & 1 deletion docs/github-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ Add the `update_times_a_day` parameter to the `Evaluate Rules` step of your gitS
```yaml
steps:
- name: Evaluate Rules
uses: linear-b/gitstream-github-action@v1
uses: linear-b/gitstream-github-action@v2
id: rules-engine
with:
full_repository: ${{ github.event.inputs.full_repository }}
Expand Down
6 changes: 3 additions & 3 deletions docs/how-it-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,10 +151,10 @@ Once gitStream is installed and configured, there are several services that will
Whenever a new PR is opened or an existing PR is changed (see also [Execution Model](https://docs.gitstream.cm/execution-model/)), the following process occurs:

1. The **git service provider API** notifies the **gitStream service** that an applicable change has occured to the PR which triggers a call to execute the **gitStream CI/CD script**.
1. The **gitStream CI/CD script** executes the GitHub Action <a href="https://github.com/linear-b/gitstream-github-action" target="_blank">`linear-b/gitstream-github-action@v1`</a> on the repository, which looks for two things:
* Valid CM files that match the filepath `.cm/*.cm`
1. The **gitStream CI/CD script** executes the GitHub Action <a href="https://github.com/linear-b/gitstream-github-action" target="_blank">`linear-b/gitstream-github-action@v2`</a> on the repository, which looks for two things:
* Valid CM files that match the filepath `.cm/*.cm`
* Any CM files that are contained in the root directory of the organization's cm repo (if applicable).
1. The **gitStream CI/CD script** passes all CM metadata to the **gitStream agent** which parses a list of all applicable CM rules.
1. The **gitStream CI/CD script** passes all CM metadata to the **gitStream agent** which parses a list of all applicable CM rules.
1. The **GitStream agent** provides the list of applicable automations to the **gitStream service**.
1. The **gitStream service** iterates through the automations and updates the PR via the **git service provider API**.

Expand Down
10 changes: 5 additions & 5 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ Some organization limit which actions can run, in that case in the repository se

![GitHub allow marketplace actions](screenshots/github_settings_allow_actions.png)

Also, add
Also, add
```
linear-b/gitstream-github-action@v2,*/*/.github/workflows/gitstream.yml*
```
linear-b/gitstream-github-action@v1,*/*/.github/workflows/gitstream.yml*
```
to the **Allow specified actions and reusable workflows** list, if it is shown.
![GitHub allow marketplace actions](screenshots/github_settings_allow_specified_actions
.png)
Expand Down Expand Up @@ -89,12 +89,12 @@ jobs:
name: gitStream workflow automation
steps:
- name: Evaluate Rules
uses: linear-b/gitstream-github-action@v1
uses: linear-b/gitstream-github-action@v2
```

## gitStream fails and I don't understand why

gitStream check run can fail from different reasons, and these are shown in the check result.
gitStream check run can fail from different reasons, and these are shown in the check result.

#### Missing workflow file

Expand Down
6 changes: 3 additions & 3 deletions plugins/filters/getCodeowners/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ When used, create a secret TOKEN, and add it to the workflow file, in GitHub:
jobs:
gitStream:
...
env:
env:
CODEOWNERS: ${{ secrets.GITSTREAM_CODEOWNERS }}
steps:
- name: Evaluate Rules
uses: linear-b/gitstream-github-action@v1
```
uses: linear-b/gitstream-github-action@v2
```

??? note "Plugin Code: getCodeowners"
```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
name: gitStream workflow automation
steps:
- name: Evaluate Rules
uses: linear-b/gitstream-github-action@v1
uses: linear-b/gitstream-github-action@v2
id: rules-engine
with:
full_repository: ${{ github.event.inputs.full_repository }}
Expand Down

0 comments on commit d64b4eb

Please sign in to comment.