Update readme

Author: thepetk

README.md

@@ -50,71 +50,95 @@ make upgrade
 
 ```Gitlab2Sentry``` requires some configuration in 3 specific files.
 
-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:
+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:
 
 ```yaml
-sentry:
-  # Sentry configuration.
-  slug: <your sentry organization>
-
-gitlab:
-  # DSN PR configuration.
-  dsn_mr:
-    # Default values for dsn (2nd) pull request configuration.
-    content: |
-      ## File generated by gitlab2sentry
-      [defaults]
-      url = {sentry_url}
-      dsn = {dsn}
-    description: <your description in the DSN PR>
-    branch_name: <default dsn branch name>
-    title: <default title of the dsn mr>
-
-  # Sentryclirc PR configuration.
-  sentryclirc_mr:
-    # Default values for .sentryclirc (1st) pull request configuration.
-    content: |
-      ## File generated by gitlab2sentry
-      [defaults]
-      url = {sentry_url}
-    description: <your description in the sentryclirc MR>
-    branch_name: <your sentryclirc branch_name
-    filepath: .sentryclirc
-    commit_message: <commit message>
-    title: <default title of the sentryclirc mr>
-
-  # Gitlab configuration.
-  config:
-    author:
-      name: <name>
-      email: <email>
-    graphql_suffix: <endpoint of gitlab graphql>
-    # Mention some specific people.
-    mentions:
-      - "@<mention>
-      - # everyone you want to include on those MRs
-    # If no "mentions" field is included, you have to define
-    # The access_level of those who will be mentioned in your PR.
-    mentions_access_level: 40
-    # This keyword must be included in your Pull Request title.
-    # Gitlab2sentry will search with this keyword for PRs
-    keyword: sentry
-    # How old has to be the projects checked from gitlab2sentry
-    creation_days_limit: 60
-    # Do you want to remove the source branch after merge?
-    remove_source: true
-    # Gitlab2Sentry searches only for group projects.
-    group_identifier: <define a keyword for the groups you want to include>
-    # Configure the aiohttp timeout for the GraphQL API of gitlab
-    graphql_aiohttp_timeout: 40
-    # How many items per page will have the response of the GraphQL API.
-    graphql_page_length: 100
+  # Sentry values
+  - name: SENTRY_TOKEN
+    valueFrom:
+      secretKeyRef:
+        key: SENTRY_TOKEN
+        name: gitlab2sentry-production
+  - name: SENTRY_DSN
+    value: your-sentry-dsn
+  - name: SENTRY_URL
+    value: your-sentry-url
+  - name: SENTRY_ORG_SLUG
+    value: your-sentry-organization-slug
+  # Gitlab values
+  - name: GITLAB_TOKEN
+    valueFrom:
+      secretKeyRef:
+        key: GITLAB_TOKEN
+        name: your-secret
+  - name: GITLAB_URL
+    value: your-gitlab-url
+    # DSN MR (1) values
+  - name: GITLAB_DSN_MR_CONTENT
+    value: the content of your dsn mr
+  - name: GITLAB_DSN_MR_DESCRIPTION
+    value: the description of your dsn mr
+  - name: GITLAB_DSN_MR_BRANCH_NAME
+    value: your-branch-name
+  - name: GITLAB_DSN_MR_TITLE
+    value: "your-dsn-mr-title"
+    # Sentryclirc MR (2) values
+  - name: GITLAB_SENTRYCLIRC_MR_CONTENT
+    value: your-sentryclirc-mr-content
+  - name: GITLAB_SENTRYCLIRC_MR_DESCRIPTION
+    value: your-sentryclirc-mr-description
+  - name: GITLAB_SENTRYCLIRC_MR_BRANCH_NAME
+    value: your-sentryclirc-mr-branch-name
+  - name: GITLAB_SENTRYCLIRC_MR_FILEPATH
+    value: .sentryclirc
+  - name: GITLAB_SENTRYCLIRC_MR_COMMIT_MSG
+    value: your-commit-msg
+  - name: GITLAB_SENTRYCLIRC_MR_TITLE
+    value: "your sentryclirc mr title"
+    # Gitlab configuration values
+  - name: GITLAB_AUTHOR_NAME
+    value: author-name
+  - name: GITLAB_AUTHOR_EMAIL
+    value: your-author-email
+  - name: GITLAB_GRAPHQL_SUFFIX
+    value: api/graphql
+  # - name: GITLAB_MENTIONS
+  #   value:
+  #     - "@all"
+  - name: GITLAB_MENTIONS_ACCESS_LEVEL
+    value: 40 # maintainer
+  - name: GITLAB_CREATION_DAYS_LIMIT
+    value: 60 # Max days old per project
+  - name: GITLAB_MR_KEYWORD
+    value: sentry # key word for searching mrs
+  - name: GITLAB_REMOVE_SOURCE
+    value: true # If the mr will remove the source branch
+  - name: GITLAB_GROUP_IDENTIFIER
+    value: your-group-identifier # will look only for group projects having this identifier
+  - name: GITLAB_AIOHTTP_TIMEOUT
+    value: 60
+  - name: GITLAB_GRAPHQL_PAGE_LENGTH
+    value: 100
 ```
 
 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```.
 
 3. You can update ```REG ?= your-registry``` and ```NS	?= your-namespace``` values inside ```Makefile```.
 
+## Manual run
+
+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.
+
+* First, you have to ```export``` all env variables which are listed above in the ```helm/values-production.yaml``` file.
+
+* Next you can run the following commands:
+
+```python
+>>> from gitlab2sentry import Gitlab2Sentry
+>>> g2s = Gitlab2Sentry()
+>>> g2s.update(full_path="projects_full_path", custom_name="optional_custom_name")
+```
+
 ## Contributions & comments welcomed
 
 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.