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-57Lines changed: 81 additions & 57 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,71 +50,95 @@ make upgrade
50
50
51
51
```Gitlab2Sentry``` requires some configuration in 3 specific files.
52
52
53
-
1. First of all you have to configure the ```g2s.yaml``` file where everything is configured for the ```gitlab2sentry``` service. Here you can find a description for every field:
53
+
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
54
55
55
```yaml
56
-
sentry:
57
-
# Sentry configuration.
58
-
slug: <your sentry organization>
59
-
60
-
gitlab:
61
-
# DSN PR configuration.
62
-
dsn_mr:
63
-
# Default values for dsn (2nd) pull request configuration.
64
-
content: |
65
-
## File generated by gitlab2sentry
66
-
[defaults]
67
-
url = {sentry_url}
68
-
dsn = {dsn}
69
-
description: <your description in the DSN PR>
70
-
branch_name: <default dsn branch name>
71
-
title: <default title of the dsn mr>
72
-
73
-
# Sentryclirc PR configuration.
74
-
sentryclirc_mr:
75
-
# Default values for .sentryclirc (1st) pull request configuration.
76
-
content: |
77
-
## File generated by gitlab2sentry
78
-
[defaults]
79
-
url = {sentry_url}
80
-
description: <your description in the sentryclirc MR>
81
-
branch_name: <your sentryclirc branch_name
82
-
filepath: .sentryclirc
83
-
commit_message: <commit message>
84
-
title: <default title of the sentryclirc mr>
85
-
86
-
# Gitlab configuration.
87
-
config:
88
-
author:
89
-
name: <name>
90
-
email: <email>
91
-
graphql_suffix: <endpoint of gitlab graphql>
92
-
# Mention some specific people.
93
-
mentions:
94
-
- "@<mention>
95
-
- # everyone you want to include on those MRs
96
-
# If no "mentions" field is included, you have to define
97
-
# The access_level of those who will be mentioned in your PR.
98
-
mentions_access_level: 40
99
-
# This keyword must be included in your Pull Request title.
100
-
# Gitlab2sentry will search with this keyword for PRs
101
-
keyword: sentry
102
-
# How old has to be the projects checked from gitlab2sentry
103
-
creation_days_limit: 60
104
-
# Do you want to remove the source branch after merge?
105
-
remove_source: true
106
-
# Gitlab2Sentry searches only for group projects.
107
-
group_identifier: <define a keyword for the groups you want to include>
108
-
# Configure the aiohttp timeout for the GraphQL API of gitlab
109
-
graphql_aiohttp_timeout: 40
110
-
# How many items per page will have the response of the GraphQL API.
111
-
graphql_page_length: 100
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
112
122
```
113
123
114
124
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```.
115
125
116
126
3. You can update ```REG ?= your-registry``` and ```NS ?= your-namespace``` values inside ```Makefile```.
117
127
128
+
## Manual run
129
+
130
+
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.
131
+
132
+
* First, you have to ```export``` all env variables which are listed above in the ```helm/values-production.yaml``` file.
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.
0 commit comments