diff --git a/docs/downloads/gitstream.yml b/docs/downloads/gitstream.yml index 1b082259..6ed87d76 100644 --- a/docs/downloads/gitstream.yml +++ b/docs/downloads/gitstream.yml @@ -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 }} diff --git a/docs/github-installation.md b/docs/github-installation.md index ca98f265..73b2ed19 100644 --- a/docs/github-installation.md +++ b/docs/github-installation.md @@ -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 }} diff --git a/docs/how-it-works.md b/docs/how-it-works.md index 508422d8..21af12e8 100644 --- a/docs/how-it-works.md +++ b/docs/how-it-works.md @@ -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 `linear-b/gitstream-github-action@v1` 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 `linear-b/gitstream-github-action@v2` 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**. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 1fa608c4..9fb8a75d 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -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) @@ -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 diff --git a/plugins/filters/getCodeowners/README.md b/plugins/filters/getCodeowners/README.md index 016d0189..8ce24cae 100644 --- a/plugins/filters/getCodeowners/README.md +++ b/plugins/filters/getCodeowners/README.md @@ -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 diff --git a/tutorials/basic-usage-python-repo/.github/workflows/gitstream.yml b/tutorials/basic-usage-python-repo/.github/workflows/gitstream.yml index bcab7fae..4457e9e2 100644 --- a/tutorials/basic-usage-python-repo/.github/workflows/gitstream.yml +++ b/tutorials/basic-usage-python-repo/.github/workflows/gitstream.yml @@ -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 }}