diff options
| author | Diogo Sousa <montezdesousa@gmail.com> | 2024-03-14 10:43:22 +0000 |
|---|---|---|
| committer | Diogo Sousa <montezdesousa@gmail.com> | 2024-03-14 10:43:22 +0000 |
| commit | 871c7bf9a91dbd1d788e5c22cd6924dc7d2bc8d7 (patch) | |
| tree | 70117e7d5fe2f9e1be86c0162557a2b9dd82b145 | |
| parent | 125bd56d5eea1d47d6447e2d9846c2a9d3a55444 (diff) | |
Update deploy to gh pages condition
| -rw-r--r-- | .github/workflows/gh-pages.yml | 5 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 3 |
2 files changed, 6 insertions, 2 deletions
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 6798a1df4c2..0ebe358c4ca 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -5,10 +5,11 @@ on: branches: - main - release/* + - "docs/*" pull_request: types: [opened, synchronize, reopened, closed] branches: - - develop + - main - "docs/*" concurrency: @@ -102,7 +103,7 @@ jobs: (startsWith(github.ref, 'refs/heads/main')) || (github.event_name == 'pull_request' && github.event.pull_request.merged == true && - github.event.pull_request.base.ref == 'develop' && + github.event.pull_request.base.ref == 'main' && startsWith(github.head_ref, 'docs/')) with: github_token: ${{ secrets.DEPLOY_TOKEN }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dd290578b6e..f514fbfa29a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1703,9 +1703,12 @@ The accepted branch naming conventions are: - `hotfix/hotfix-name` - `release/2.1.0` or `release/2.1.0rc0`. - `bugfix/bugfix-name` +- `docs/docs-name` All `feature/feature-name` related branches can only have PRs pointing to `develop` branch. `hotfix/hotfix-name` and `release/*` branches can only have PRs pointing to `main` branch. +The `docs/docs-name` branch is used to update static documentation (files that are not automatically generated) in-between releases. + ## Installers When implementing a new feature or fixing something within the codebase, it is necessary to ensure that it is working |