Skip to content

Commit

Permalink
update branch names in docs and workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
sainak committed Mar 18, 2024
1 parent 99ab4e0 commit 23c436f
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 11 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ name: Docs
on:
push:
branches:
- master
- develop
paths:
- "docs/**"
pull_request:
branches:
- master
- develop
paths:
- "docs/**"
workflow_dispatch:
Expand Down Expand Up @@ -46,7 +46,7 @@ jobs:
retention-days: 30

deploy-docs:
if: github.repository == 'coronasafe/care' && github.ref == 'refs/heads/master'
if: github.repository == 'coronasafe/care' && github.ref == 'refs/heads/develop'
name: Deploy docs
runs-on: ubuntu-latest
needs: build-docs
Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@ name: Lint Code Base

on:
pull_request:
branches: [master]
branches:
- develop
- staging
merge_group:

jobs:
Expand All @@ -24,7 +26,7 @@ jobs:
- name: Lint Code Base
uses: github/super-linter/slim@v5
env:
DEFAULT_BRANCH: master
DEFAULT_BRANCH: develop
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
VALIDATE_ALL_CODEBASE: false
VALIDATE_PYTHON_BLACK: true
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ repos:
rev: v4.4.0
hooks:
- id: no-commit-to-branch
args: [--branch, master, --branch, production]
args: [--branch, develop, --branch, staging, --branch, production]
- id: check-merge-conflict
- id: check-builtin-literals
- id: mixed-line-ending
Expand Down
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
},
"files.trimFinalNewlines": true,
"files.trimTrailingWhitespace": true,
"githubPullRequests.ignoredPullRequestBranches": ["master"],
"githubPullRequests.ignoredPullRequestBranches": ["develop", "staging"],
"python.formatting.blackPath": "${workspaceFolder}/.venv/bin/black",
"python.formatting.provider": "black",
"python.languageServer": "Pylance",
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ pre-commit install

to run pre-commit on your branch:
```bash
pre-commit run --files $(git diff --name-only master...HEAD)
pre-commit run --files $(git diff --name-only develop...HEAD)
```

#### Using Docker
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,11 @@ You can find the docs at https://care-be-docs.coronasafe.network

### Staging Deployments

Staging instances for testing are automatically deployed on every commit to the `master` branch. The staging instances
are available at:
Dev and staging instances for testing are automatically deployed on every commit to the `develop` and `staging` branches.
The staging instances are available at:

- https://careapi.ohc.network
- https://careapi-staging.ohc.network

### Self hosting

Expand Down
4 changes: 3 additions & 1 deletion docs/github-repo/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ GitHub Repository

The Github Repo available here_ contains the source code for the care project, Apart from the secrets configured at runtime, the exact copy is deployed in production.

The :code:`master` branch auto deploys to the Development instance and is regarded as the Beta version of the application.
The :code:`develop` branch auto deploys to the Development instance and is regarded as the Beta version of the application.

The :code:`staging` branch auto deploys to the Staging instance and is regarded as the Release Candidate version of the application.

The :code:`production` branch auto deploys to Production instance and is regarded as the Stable version of the application.

Expand Down

0 comments on commit 23c436f

Please sign in to comment.