arcanis/arcanis.me
1
0
Fork 0
mirror of https://github.com/arcan1s/arcanis.me.git synced 2025-07-15 22:19:54 +00:00
Code Issues Projects Releases Wiki Activity

more pretty md files

Browse Source
This commit is contained in:
Evgenii Alekseev
2016-02-02 00:55:13 +07:00
parent c0ad1a6912
commit 518956bdff
39 changed files with 1550 additions and 484 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
projects/_posts/2014-07-27-reportabug.md
View File

@ -14,7 +14,10 @@ links:
---
<!-- info block -->
Qt application/library which allows users to create an issue for projects which are hosted on GitHub. It may work over [GitHub](//github.com "GitHub") or [GitReport](//gitreports.com/ "GitReports"). It works fine, but it was created as proof-of-concept.
Qt application/library which allows users to create an issue for projects which
are hosted on GitHub. It may work over [GitHub](//github.com "GitHub") or
[GitReport](//gitreports.com/ "GitReports"). It works fine, but it was created
as proof-of-concept.
<!--more-->
@ -36,7 +39,8 @@ Qt application/library which allows users to create an issue for projects which
#### <a href="#singleapp" class="anchor" id="singleapp"><span class="octicon octicon-link"></span></a>Build as a standalone application
* Download the actual source [tarball](//github.com/arcan1s/reportabug/releases "GitHub").
* Download the actual source [tarball](//github.com/arcan1s/reportabug/releases
"GitHub").
* Extract it and set up your configuration.
* Install the application:
@ -50,7 +54,8 @@ Qt application/library which allows users to create an issue for projects which
#### <a href="#aslibrary" class="anchor" id="aslibrary"><span class="octicon octicon-link"></span></a>Build as a library in your project
* Download the actual source [tarball](//github.com/arcan1s/reportabug/releases "GitHub").
* Download the actual source [tarball](//github.com/arcan1s/reportabug/releases
"GitHub").
* Extract it and set up your configuration.
* include it into your project. For example if you use `cmake`:
@ -86,7 +91,8 @@ I want note that all were tested on latest version of dependencies.
* automoc4 *(make)*
* cmake *(make)*
* doxygen *(make, documentation)*
* qt5-webkit (if Qt5 is used) **or** qtwebkit (if Qt4 is used) *(optional, required by GitReports module)*
* qt5-webkit (if Qt5 is used) **or** qtwebkit (if Qt4 is used) *(optional,
required by GitReports module)*
<!-- end of install block -->
@ -95,7 +101,9 @@ I want note that all were tested on latest version of dependencies.
### <a href="#github" class="anchor" id="github"><span class="octicon octicon-link"></span></a>GitHub module
This module creates an issue over GitHub. [GitHub API](//developer.github.com/v3/issues/ "Documentation") is used for creating issue. User should type own username and password. The typical POST request is:
This module creates an issue over GitHub. [GitHub API](//developer.github.com/v3/issues/
"Documentation") is used for creating issue. User should type own username and
password. The typical POST request is:
```bash
curl -X POST -u user:pass -d '{"title":"A new bug","body":"Some error occurs"}' \
@ -104,7 +112,10 @@ curl -X POST -u user:pass -d '{"title":"A new bug","body":"Some error occurs"}'
To disable this module use `-DENABLE_GITHUB=0` cmake flag.
This module may send request using developer's token too. Please visit [this page](//github.com/settings/applications "Settings") and generate a new one. Needed scopes are `public_repo` (or `repo` if you will use it for a private repository).
This module may send request using developer's token too. Please visit [this
page](//github.com/settings/applications "Settings") and generate a new one.
Needed scopes are `public_repo` (or `repo` if you will use it for a private
repository).
**Please keep in mind that passing the token in the clear, you may discredit your account.**
@ -121,16 +132,21 @@ This module requires `QtNetwork` module.
### <a href="#gitreports" class="anchor" id="gitreports"><span class="octicon octicon-link"></span></a>GitReports module
This module creates issue over [GitReports](//gitreports.com/about "GitReports"). Please visit [this page](//gitreports.com/ "GitReports") and set up it for your repository.
This module creates issue over [GitReports](//gitreports.com/about "GitReports").
Please visit [this page](//gitreports.com/ "GitReports") and set up it for your
repository.
To disable this module use `-DENABLE_GITREPORT=0` cmake flag. This module requires `QtNetwork` and `QtWebKit` modules.
To disable this module use `-DENABLE_GITREPORT=0` cmake flag. This module requires
`QtNetwork` and `QtWebKit` modules.
<!-- end of howto block -->
<!-- config block -->
## <a href="#config" class="anchor" id="config"><span class="octicon octicon-link"></span></a>Configuration
For the developer configuration please use `config.h` header. Also you may load parametrs dynamically using `params` array (needed keys is the same as for the header
For the developer configuration please use `config.h` header. Also you may load
parametrs dynamically using `params` array (needed keys is the same as for the
header
### <a href="#mainconfig" class="anchor" id="mainconfig"><span class="octicon octicon-link"></span></a>Main configuration
@ -138,20 +154,31 @@ For the developer configuration please use `config.h` header. Also you may load
* `PROJECT` - the project name.
* `TAG_BODY` - default body of an issue. It may be used for both modules.
* `TAG_TITLE` - default title of an issue. It may be used only for GitHub module.
* `TAG_ASSIGNEE` - assign an issue to this account. It may be used only for GitHub module. This tag will work only if user has push access. If it will be empty, it will be ignored.
* `TAG_LABELS` - set these labels to an issue. Labels should be comma separated. It may be used only for GitHub module. This tag will work only if user has push access. If it will be empty, it will be ignored.
* `TAG_MILESTONE` - set this milestone to an issue. It may be used only for GitHub module. This tag will work only if user has push access. If it will be empty, it will be ignored.
* `TAG_ASSIGNEE` - assign an issue to this account. It may be used only for
GitHub module. This tag will work only if user has push access. If it will be
empty, it will be ignored.
* `TAG_LABELS` - set these labels to an issue. Labels should be comma separated.
It may be used only for GitHub module. This tag will work only if user has push
access. If it will be empty, it will be ignored.
* `TAG_MILESTONE` - set this milestone to an issue. It may be used only for
GitHub module. This tag will work only if user has push access. If it will be
empty, it will be ignored.
### <a href="#githubconfig" class="anchor" id="githubconfig"><span class="octicon octicon-link"></span></a>GitHub module settings
* `GITHUB_COMBOBOX` - text of this module into comboBox.
* `ISSUES_URL` - issues url, in the most cases do not touch it. Default is `//api.github.com/repos/$OWNER/$PROJECT/issues`. Available tags here are `$PROJECT`, `$OWNER`.
* `ISSUES_URL` - issues url, in the most cases do not touch it. Default is
`//api.github.com/repos/$OWNER/$PROJECT/issues`. Available tags here are
`$PROJECT`, `$OWNER`.
### <a href="#gitreportsconfig" class="anchor" id="gitreportsconfig"><span class="octicon octicon-link"></span></a>GitReports module settings
* `CAPTCHA_URL` - captcha url, in the most cases do not touch it. Default is `//gitreports.com/simple_captcha?code=`.
* `CAPTCHA_URL` - captcha url, in the most cases do not touch it. Default is
`//gitreports.com/simple_captcha?code=`.
* `GITREPORT_COMBOBOX` - text of this module into comboBox.
* `PUBLIC_URL` - issues url, in the most cases do not touch it. Default is `//gitreports.com/issue/$OWNER/$PROJECT`. Available tags here are `$PROJECT`, `$OWNER`.
* `PUBLIC_URL` - issues url, in the most cases do not touch it. Default is
`//gitreports.com/issue/$OWNER/$PROJECT`. Available tags here are `$PROJECT`,
`$OWNER`.
<!-- end of config block -->