-
Notifications
You must be signed in to change notification settings - Fork 25
/
README.md.tt
129 lines (83 loc) · 3.31 KB
/
README.md.tt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
[](REPO_URL goes here)
## Introduction
> *App introduction goes here ...*
## Getting Started
### Prerequisites
- Ruby version: <%= RUBY_VERSION %>
<%- if WEB_VARIANT -%>
- Node version: <%= NODE_VERSION %>
<%- end -%>
### Docker
- Install [Docker for Mac](https://docs.docker.com/docker-for-mac/install/)
### Development
Copy the contents of `.env.example` to `.env`
```sh
cp .env.example .env
```
Run the Rails app:
```sh
make dev
```
## Testing
### Docker-based tests on the CI server
Add the following build settings to run the tests in the Docker environment via Docker Compose (configuration in `docker-compose.test.yml`):
- Configure the environment variable `BRANCH_TAG` to tag Docker images per branch, e.g:
```sh
# a unique `BRANCH_TAG` value to tag the Docker image
# e.g $SEMAPHORE_BRANCH_ID or using the
# or using nimblehq/branch-tag-action@1 Github action
export BRANCH_TAG= # unique value for tagging Docker image
```
Each branch needs to have its own Docker image to avoid build settings disparities and leverage Docker image caching.
> BRANCH_TAG must not contain special characters (`/`) to be valid. So using $BRANCH_NAME will not work e.g. chore/setup-docker.
An alternative is to use a unique identifier such as PR_ID or BRANCH_ID on the CI server.
- Pull the latest version the Docker image for the branch:
```sh
docker pull $DOCKER_IMAGE:$BRANCH_TAG || true
```
On each build, the CI environment does not contain yet a cached version of the image. Therefore, it is required to pull
it first to leverage the `cache_from` settings of Docker Compose which avoids rebuilding the whole Docker image on subsequent test builds.
- Build the Docker image:
```sh
./bin/docker-prepare && docker compose -f docker-compose.test.yml build
```
Upon the first build, the whole Docker image is built from the ground up and tagged using `$BRANCH_TAG`.
- Push the latest version of the Docker image for this branch:
```sh
docker push $DOCKER_IMAGE:$BRANCH_TAG
```
- Setup the test database:
```sh
docker compose -f docker-compose.test.yml run test bin/bundle exec rake db:test:prepare
```
### Test
- Run all tests:
```sh
# Docker way
docker compose -f docker-compose.test.yml run test
# Non-Docker way
rspec
```
- Run a specific test:
```sh
# Docker way
docker compose -f docker-compose.test.yml run test bin/bundle exec rspec [rspec-params]
# Non-Docker way
rspec [rspec-params]
```
### Linting
- Run all lint:
```sh
make codebase
```
- Fix all lint:
```sh
make codebase/fix
```
### Automated Code Review Setup
- Add a bot (i.e. `team-nimblehq`) to this repository or to the organization. The bot requires permission level “Write” to be able to set a PR’s status.
- Create a [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
from bot account with `public_repo` scope, and set it as `DANGER_GITHUB_API_TOKEN` secret on the CI Environment Settings.
## CI/CD
The project relies entirely on [Github Actions](https://github.com/features/actions) for CI/CD via multiple workflows located under the [`.github/workflows/`](.github/workflows) directory.
Please check out the [`.github/workflows/README.md`](.github/workflows/README.md) file for further instructions.