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
+20-6Lines changed: 20 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,11 +36,11 @@ After doing this, the autolinking of issues, commits, and branches will work. Se
36
36
37
37
The user must be a member of the project you want to copy or else you won't see it in the first step.
38
38
39
-
1.`cp sample_settings.js settings.js`
40
-
1. edit settings.js
39
+
1.`cp sample_settings.ts settings.ts`
40
+
1. edit settings.ts
41
41
1. run `npm run start`
42
42
43
-
## Where to find info for the `settings.js`
43
+
## Where to find info for the `settings.ts`
44
44
45
45
### gitlab
46
46
@@ -50,7 +50,7 @@ The URL under which your gitlab instance is hosted. Default is the official `htt
50
50
51
51
#### gitlab.token
52
52
53
-
Go to [Settings / Access Tokens](https://gitlab.com/profile/personal_access_tokens). Create a new Access Token with `api` and `read_repository` scopes and copy that into the `settings.js`
53
+
Go to [Settings / Access Tokens](https://gitlab.com/profile/personal_access_tokens). Create a new Access Token with `api` and `read_repository` scopes and copy that into the `settings.ts`
54
54
55
55
#### gitlab.projectID
56
56
@@ -68,15 +68,29 @@ Under which organisation or user will the new project be hosted
68
68
69
69
#### github.token
70
70
71
-
Go to [Settings / Developer settings / Personal access tokens](https://github.com/settings/tokens). Generate a new token with `repo` scope and copy that into the `settings.js`
71
+
Go to [Settings / Developer settings / Personal access tokens](https://github.com/settings/tokens). Generate a new token with `repo` scope and copy that into the `settings.ts`
72
72
73
73
#### github.repo
74
74
75
75
What is the name of the new repo
76
76
77
+
### s3 (optional)
78
+
79
+
S3 can be used to store attachments from issues. If omitted, `has attachment` label will be added to GitHub issue.
80
+
81
+
#### s3.accessKeyId and s3.secretAccessKey
82
+
83
+
AWS [credentials](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys) that are used to copy attachments from GitLab into the S3 bucket.
84
+
85
+
IAM User who owns these credential must have [write permissions](https://docs.aws.amazon.com/AmazonS3/latest/dev/example-policies-s3.html#iam-policy-ex0) to the bucket.
86
+
87
+
#### s3.bucket
88
+
89
+
Existing bucket, with an appropriate security policy. One possible policy is to allow [public access](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteAccessPermissionsReqd.html).
90
+
77
91
#### debug
78
92
79
-
As default it is set to false. Doesn't fire the requests to github api and only does the work on the gitlabb side to test for wonky cases before using up api-calls
93
+
As default it is set to false. Doesn't fire the requests to github api and only does the work on the gitlab side to test for wonky cases before using up api-calls
0 commit comments