Skip to content

Commit ac590ca

Browse files
committed
updated docs for Basic Auth
1 parent 9ce55ff commit ac590ca

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

docs/changelog.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Changelog
22
=========
33

4+
* **1.2.3** (29.03.2015)
5+
* support for Basic Auth username and password (GitHub tokens!)
46
* **1.2.2** (21.03.2015)
57
* use newer GrGit (and JGit) version with some bugfixes
68
* start using Coveralls

docs/configuration/authorization.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ All interactive authorization mechanisms are provided by `grgit <https://github.
88
see `authorization docs <http://ajoberstar.org/grgit/docs/groovydoc/org/ajoberstar/grgit/auth/AuthConfig.html>`_
99
for more information.
1010

11+
Interactive mode is default option, switched off by using any special properties described below.
12+
1113
SSH Key/password
1214
----------------
1315

@@ -51,3 +53,27 @@ dynamically using custom Gradle tasks right before release. To change credential
5153
task release {
5254
dependsOn loadKeyPassword
5355
}
56+
57+
58+
HTTP Basic Auth/GitHub tokens
59+
-----------------------------
60+
61+
Same as with SSH keys, ``axion-release-plugin``gives option to set basic auth data when connecting to repository via
62+
HTTP. This is especially useful when using `GitHub OAuth tokens <https://help.github.com/articles/git-automation-with-oauth-tokens/>`_.
63+
64+
Command line
65+
^^^^^^^^^^^^
66+
67+
Use ``release.customUsername`` and ``release.customPassword`` properties to set username and password that will be provided
68+
when using Basic Auth. If password is not set, it defaults to empty string.
69+
70+
Dynamic
71+
^^^^^^^
72+
73+
Username and password can be provided in runtime, just before push is made via ``scmVersion.repository.customUsername``
74+
and ``scmVersion.repository.customPassword`` properties::
75+
76+
77+
task loadGitHubToken << {
78+
scmVersion.repository.customUsername = loadGitHubTokenFromSomewhere()
79+
}

0 commit comments

Comments
 (0)