You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+81-81Lines changed: 81 additions & 81 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,12 +8,11 @@ Any new Gitlab repository you create will be offered a Sentry project if you acc
8
8
9
9
## Two-Steps process
10
10
11
-
1. After creating your new project on Gitlab, ```gitlab2sentry``` will create a first Merge Request asking if you want it to create an associated Sentry project for it. This Merge Request will contain the creation of a ```.sentryclirc``` file which, if you merge it, will be contributed back the newly created Sentry project ```DSN``` for this project.
11
+
1. After creating your new project on Gitlab, `gitlab2sentry` will create a first Merge Request asking if you want it to create an associated Sentry project for it. This Merge Request will contain the creation of a `.sentryclirc` file which, if you merge it, will be contributed back the newly created Sentry project `DSN` for this project.
12
12
13
-
2. If you merged the first Merge Request, ```gitlab2sentry``` will create a second one to update the newly created ```.sentryclirc``` file with the ```DSN``` of the sentry project. Moreover, after the merge of the first Merge Request ```gitlabsentry``` will create a new ```sentry project```, update its rate limit and save the ```DSN``` inside ```.sentryclirc```. Once you have merged this second Merge Request everything will be set up!
14
-
15
-
**NOTE**: ```Gitlab2Sentry``` looks only for group projects and searches for MRs having specific keyword inside (check "Configuration" section)
13
+
2. If you merged the first Merge Request, `gitlab2sentry` will create a second one to update the newly created `.sentryclirc` file with the `DSN` of the sentry project. Moreover, after the merge of the first Merge Request `gitlabsentry` will create a new `sentry project`, update its rate limit and save the `DSN` inside `.sentryclirc`. Once you have merged this second Merge Request everything will be set up!
16
14
15
+
**NOTE**: `Gitlab2Sentry` looks only for group projects and searches for MRs having specific keyword inside (check "Configuration" section)
17
16
18
17
## Run locally
19
18
@@ -38,7 +37,7 @@ python3 run.py
38
37
39
38
## Deployment
40
39
41
-
We prefer to deploy and manage ```gitlab2sentry``` with ```helm```. Inside ```helm/``` folder you can find an example deployment.
40
+
We prefer to deploy and manage `gitlab2sentry` with `helm`. Inside `helm/` folder you can find an example deployment.
42
41
43
42
You can upgrade your deployment with:
44
43
@@ -48,92 +47,94 @@ make upgrade
48
47
49
48
## Configuration
50
49
51
-
```Gitlab2Sentry``` requires some configuration in 3 specific files.
50
+
`Gitlab2Sentry` requires some configuration in 3 specific files.
1. First of all you have to configure the ```helm/values-production.yaml``` file where everything is configured for the ```gitlab2sentry``` service. Here you can find a description for every field:
54
+
1. First of all you have to configure the `helm/values-production.yaml` file where everything is configured for the `gitlab2sentry` service. Here you can find a description for every field:
54
55
55
56
```yaml
56
-
# Sentry values
57
-
- name: SENTRY_TOKEN
58
-
valueFrom:
59
-
secretKeyRef:
60
-
key: SENTRY_TOKEN
61
-
name: gitlab2sentry-production
62
-
- name: SENTRY_DSN
63
-
value: your-sentry-dsn
64
-
- name: SENTRY_URL
65
-
value: your-sentry-url
66
-
- name: SENTRY_ORG_SLUG
67
-
value: your-sentry-organization-slug
68
-
# Gitlab values
69
-
- name: GITLAB_TOKEN
70
-
valueFrom:
71
-
secretKeyRef:
72
-
key: GITLAB_TOKEN
73
-
name: your-secret
74
-
- name: GITLAB_URL
75
-
value: your-gitlab-url
76
-
# DSN MR (1) values
77
-
- name: GITLAB_DSN_MR_CONTENT
78
-
value: the content of your dsn mr
79
-
- name: GITLAB_DSN_MR_DESCRIPTION
80
-
value: the description of your dsn mr
81
-
- name: GITLAB_DSN_MR_BRANCH_NAME
82
-
value: your-branch-name
83
-
- name: GITLAB_DSN_MR_TITLE
84
-
value: "your-dsn-mr-title"
85
-
# Sentryclirc MR (2) values
86
-
- name: GITLAB_SENTRYCLIRC_MR_CONTENT
87
-
value: your-sentryclirc-mr-content
88
-
- name: GITLAB_SENTRYCLIRC_MR_DESCRIPTION
89
-
value: your-sentryclirc-mr-description
90
-
- name: GITLAB_SENTRYCLIRC_MR_BRANCH_NAME
91
-
value: your-sentryclirc-mr-branch-name
92
-
- name: GITLAB_SENTRYCLIRC_MR_FILEPATH
93
-
value: .sentryclirc
94
-
- name: GITLAB_SENTRYCLIRC_MR_COMMIT_MSG
95
-
value: your-commit-msg
96
-
- name: GITLAB_SENTRYCLIRC_MR_TITLE
97
-
value: "your sentryclirc mr title"
98
-
# Gitlab configuration values
99
-
- name: GITLAB_AUTHOR_NAME
100
-
value: author-name
101
-
- name: GITLAB_AUTHOR_EMAIL
102
-
value: your-author-email
103
-
- name: GITLAB_GRAPHQL_SUFFIX
104
-
value: api/graphql
105
-
# - name: GITLAB_MENTIONS
106
-
# value:
107
-
# - "@all"
108
-
- name: GITLAB_MENTIONS_ACCESS_LEVEL
109
-
value: 40 # maintainer
110
-
- name: GITLAB_CREATION_DAYS_LIMIT
111
-
value: 60 # Max days old per project
112
-
- name: GITLAB_MR_KEYWORD
113
-
value: sentry # key word for searching mrs
114
-
- name: GITLAB_REMOVE_SOURCE
115
-
value: true # If the mr will remove the source branch
116
-
- name: GITLAB_GROUP_IDENTIFIER
117
-
value: your-group-identifier # will look only for group projects having this identifier
118
-
- name: GITLAB_AIOHTTP_TIMEOUT
119
-
value: 60
120
-
- name: GITLAB_GRAPHQL_PAGE_LENGTH
121
-
value: 100
122
-
- name: GITLAB_MR_LABEL_LIST
123
-
value: "sentry,your-label" # comma separated list of labels for the mr
57
+
# Sentry values
58
+
- name: SENTRY_TOKEN
59
+
valueFrom:
60
+
secretKeyRef:
61
+
key: SENTRY_TOKEN
62
+
name: gitlab2sentry-production
63
+
- name: SENTRY_DSN
64
+
value: your-sentry-dsn
65
+
- name: SENTRY_URL
66
+
value: your-sentry-url
67
+
- name: SENTRY_ORG_SLUG
68
+
value: your-sentry-organization-slug
69
+
# Gitlab values
70
+
- name: GITLAB_TOKEN
71
+
valueFrom:
72
+
secretKeyRef:
73
+
key: GITLAB_TOKEN
74
+
name: your-secret
75
+
- name: GITLAB_URL
76
+
value: your-gitlab-url
77
+
# DSN MR (1) values
78
+
- name: GITLAB_DSN_MR_CONTENT
79
+
value: the content of your dsn mr
80
+
- name: GITLAB_DSN_MR_DESCRIPTION
81
+
value: the description of your dsn mr
82
+
- name: GITLAB_DSN_MR_BRANCH_NAME
83
+
value: your-branch-name
84
+
- name: GITLAB_DSN_MR_TITLE
85
+
value: "your-dsn-mr-title"
86
+
# Sentryclirc MR (2) values
87
+
- name: GITLAB_SENTRYCLIRC_MR_CONTENT
88
+
value: your-sentryclirc-mr-content
89
+
- name: GITLAB_SENTRYCLIRC_MR_DESCRIPTION
90
+
value: your-sentryclirc-mr-description
91
+
- name: GITLAB_SENTRYCLIRC_MR_BRANCH_NAME
92
+
value: your-sentryclirc-mr-branch-name
93
+
- name: GITLAB_SENTRYCLIRC_MR_FILEPATH
94
+
value: .sentryclirc
95
+
- name: GITLAB_SENTRYCLIRC_MR_COMMIT_MSG
96
+
value: your-commit-msg
97
+
- name: GITLAB_SENTRYCLIRC_MR_TITLE
98
+
value: "your sentryclirc mr title"
99
+
# Gitlab configuration values
100
+
- name: GITLAB_AUTHOR_NAME
101
+
value: author-name
102
+
- name: GITLAB_AUTHOR_EMAIL
103
+
value: your-author-email
104
+
- name: GITLAB_GRAPHQL_SUFFIX
105
+
value: api/graphql
106
+
# - name: GITLAB_MENTIONS
107
+
# value:
108
+
# - "@all"
109
+
- name: GITLAB_MENTIONS_ACCESS_LEVEL
110
+
value: 40 # maintainer
111
+
- name: GITLAB_CREATION_DAYS_LIMIT
112
+
value: 60 # Max days old per project
113
+
- name: GITLAB_MR_KEYWORD
114
+
value: sentry # key word for searching mrs
115
+
- name: GITLAB_REMOVE_SOURCE
116
+
value: true # If the mr will remove the source branch
117
+
- name: GITLAB_GROUP_IDENTIFIER
118
+
value: your-group-identifier # will look only for group projects having this identifier
119
+
- name: GITLAB_AIOHTTP_TIMEOUT
120
+
value: 60
121
+
- name: GITLAB_GRAPHQL_PAGE_LENGTH
122
+
value: 100
123
+
- name: GITLAB_MR_LABEL_LIST
124
+
value: "sentry,your-label" # comma separated list of labels for the mr
124
125
```
125
126
126
-
2. If you want to follow the ```helm``` deployment process you will have to fill your details into the ```helm/values-production.yaml``` and ```helm/Chart.yaml```.
127
+
2. If you want to follow the `helm` deployment process you will have to fill your details into the `helm/values-production.yaml` and `helm/Chart.yaml`.
127
128
128
-
3. You can update ```REG ?= your-registry``` and ```NS ?= your-namespace``` values inside ```Makefile```.
129
+
3. You can update `REG ?= your-registry` and `NS ?= your-namespace` values inside `Makefile`.
129
130
130
131
## Manual run
131
132
132
-
If you want to update a specific project (for example if the project has a very big name or is older than the ```GITLAB_CREATION_DAYS_LIMIT``` value), you can run the ```gitlab2sentry``` manually.
133
+
If you want to update a specific project (for example if the project has a very big name or is older than the `GITLAB_CREATION_DAYS_LIMIT` value), you can run the `gitlab2sentry` manually.
133
134
134
-
* First, you have to ```export``` all env variables which are listed above in the ```helm/values-production.yaml``` file.
135
+
- First, you have to `export` all env variables which are listed above in the `helm/values-production.yaml` file.
135
136
136
-
* Next you can run the following commands:
137
+
- Next you can run the following commands:
137
138
138
139
```python
139
140
>>> from gitlab2sentry import Gitlab2Sentry
@@ -146,4 +147,3 @@ If you want to update a specific project (for example if the project has a very
146
147
Numberly decided to Open Source this project because it saves a lot of time internally to all our developers and helped foster the mass adoption of Sentry in all our Tech teams. We hope this project can benefit someone else.
147
148
148
149
Feel free to ask questions, suggest improvements and of course contribute features or fixes you might need!
This application uses `pydantic`'s `BaseSettings` for configuration, which allows you to set and override parameters using environment variables. Below, you'll find a list of all the configuration options and the expected environment variables. Each configuration setting has a default value, but you can easily override them to suit your deployment needs.
4
+
5
+
To configure the application, set the following environment variables:
6
+
7
+
| Environment Variable | Description | Default Value |
0 commit comments