Skip to content

Commit 9fed7f6

Browse files
committed
Remove non-essentials from config file
Instead, users are pointed to the website where all configuration options are listed.
1 parent 016e8f7 commit 9fed7f6

File tree

3 files changed

+16
-28
lines changed

3 files changed

+16
-28
lines changed

Diff for: README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Fork of one of the tools by [Max Korenkov](https://github.com/mkorenkov) separat
77

88
#### Usage ####
99

10-
The script will by default look for a file named `config.ini` located in the same folder as the Python script. For a list of all possible configuration options, see [Configuration](http://www.iqandreas.com/github-issues-import/configuration/).
10+
The script will by default look for a file named `config.ini` located in the same folder as the Python script. For a list of all possible configuration options, see [_Configuration_](http://www.iqandreas.com/github-issues-import/configuration/).
1111

12-
To quickly get started, rename `config.ini.sample` to `config.ini`, and edit the fields to match your login info and repository info. If you want to use a different credentials for the source and target repositories, please see [Configuration: Enterprise Accounts and Advanced Login Options](http://www.iqandreas.com/github-issues-import/configuration/#enterprise). Store the config file in the same folder as the `gh-issues-import.py` script, or store it in a different folder, using the `--config <file>` option to specify which config file to load in.
12+
To quickly get started, rename `config.ini.sample` to `config.ini`, and edit the fields to match your login info and repository info. If you want to use a different credentials for the source and target repositories, please see [_Configuration: Enterprise Accounts and Advanced Login Options_](http://www.iqandreas.com/github-issues-import/configuration/#enterprise). Store the config file in the same folder as the `gh-issues-import.py` script, or store it in a different folder, using the `--config <file>` option to specify which config file to load in.
1313

1414
**Warning:** The password is stored in plain-text, so avoid storing the config file in a public repository. To avoid this, you can instead pass the username and/or password as arguments by using the `-u <username>` and `-p <password>` flags respectively. If the username or password is not passed in from either of these locations, the user will be prompted for them when the script runs.
1515

@@ -43,7 +43,7 @@ If allowed by GitHub's policies, it may be a good idea to use a "neutral" accoun
4343

4444
#### Templates ####
4545

46-
The script will by default use the [Markdown-formatted](http://github.github.com/github-flavored-markdown/) templates found in the [`templates`](templates/) directory. You can edit those, or point to your own templates from the config file.
46+
The script will by default use the [Markdown-formatted](http://github.github.com/github-flavored-markdown/) templates found in the [`templates`]({{site.github_url}}/tree/master/templates/) directory. You can edit those, or point to your own templates from the config file; see [_Custom Templates_](http://www.iqandreas.com/github-issues-import/templates/) for more details.
4747

4848
#### Examples ####
4949

Diff for: config-enterprise.ini.sample

+8-14
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,20 @@
11
# Rename to `config.ini`, and keep it in the same folder as `gh-issues-import.py`
2-
# All optional fields have been commented out.
2+
# For a full list of options, see <http://www.iqandreas.com/github-issues-import/configuration/>
33

44
[source]
55
server = github.com
6-
repository = octocat/Hello-World
7-
username = user@example.com
8-
password = naked_password
6+
repository = OctoCat/Hello-World
7+
username = octocat@github.com
8+
password = plaintext_pa$$w0rd
99

1010
[target]
11-
server = helloworld.org
12-
repository = helloworld-inc/Hello-World
13-
username = other_user@helloworld.org
14-
password = naked_password
11+
server = octodog.org
12+
repository = OctoDog/Hello-World
13+
username = admin@octodog.org
14+
password = plaintext_pass\/\/ord
1515

1616
[format] # These can be adjusted based on your group's region and language.
1717

18-
# Unless an absolute path is given, the templates are relative to the current working directory.
19-
# Example (and default) templates can be found in the `templates` folder.
20-
#issue_template = templates/issue.md
21-
#pull_request_template = templates/pull_request.md
22-
#comment_template = templates/comment.md
23-
2418
# If unsure, just using '%c' will default to the locale’s appropriate date and time representation.
2519
#date = %A %b %d, %Y at %H:%M GMT # Sample: Friday Sep 13, 2013 at 22:58 GMT
2620

Diff for: config.ini.sample

+5-11
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,18 @@
11
# Rename to `config.ini`, and keep it in the same folder as `gh-issues-import.py`
2-
# All optional fields have been commented out.
2+
# For a full list of options, see <http://www.iqandreas.com/github-issues-import/configuration/>
33

44
[login]
5-
6-
password = naked_password
5+
username = OctoDog
6+
password = plaintext_pa$$w0rd
77

88
[source]
9-
repository = octocat/Hello-World
9+
repository = OctoCat/Hello-World
1010

1111
[target]
12-
repository = helloworld-inc/Hello-World
12+
repository = OctoDog/Hello-World
1313

1414
[format] # These can be adjusted based on your group's region and language.
1515

16-
# Unless an absolute path is given, the templates are relative to the current working directory.
17-
# Example (and default) templates can be found in the `templates` folder.
18-
#issue_template = templates/issue.md
19-
#pull_request_template = templates/pull_request.md
20-
#comment_template = templates/comment.md
21-
2216
# If unsure, just using '%c' will default to the locale’s appropriate date and time representation.
2317
#date = %A %b %d, %Y at %H:%M GMT # Sample: Friday Sep 13, 2013 at 22:58 GMT
2418

0 commit comments

Comments
 (0)