Skip to content

Commit e869edc

Browse files
committed
Move gitea doc file to forgejo
1 parent 9e1a0ca commit e869edc

1 file changed

Lines changed: 41 additions & 41 deletions

File tree

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
Gitea
1+
Forgejo
22
======
33

4-
You can import tasks from your Gitea instance using
5-
the ``gitea`` service name.
4+
You can import tasks from your Forgejo instance using
5+
the ``forgejo`` service name.
66

77
Example Service
88
---------------
99

10-
Here's an example of a Gitea target:
10+
Here's an example of a Forgejo target:
1111

1212
.. config::
1313

14-
[user_gitea]
15-
service = gitea
16-
gitea.username = ralphbean
17-
gitea.host = git.bean.com #Note: the lack of https, the service will assume HTTPS by default.
18-
gitea.token = @oracle:eval:pass show 'git.bean.com token'
14+
[user_forgejo]
15+
service = forgejo
16+
forgejo.username = ralphbean
17+
forgejo.host = git.bean.com #Note: the lack of https, the service will assume HTTPS by default.
18+
forgejo.token = @oracle:eval:pass show 'git.bean.com token'
1919

2020
The above example is the minimum required to import issues from
21-
Gitea. You can also feel free to use any of the
21+
Forgejo. You can also feel free to use any of the
2222
configuration options described in :ref:`common_configuration_options`
2323
or described in `Service Features`_ below.
2424

@@ -40,9 +40,9 @@ could add this line to your service configuration (replacing ``me`` by your own
4040
login):
4141

4242
.. config::
43-
:fragment: gitea
43+
:fragment: forgejo
4444

45-
gitea.include_repos = me/project_foo, bar/project_fox
45+
forgejo.include_repos = me/project_foo, bar/project_fox
4646

4747
Alternatively, if you have a particularly noisy repository, you can
4848
instead choose to import all issues excepting it using the
@@ -52,60 +52,60 @@ In this example, ``noisy/repository`` is the repository you would
5252
*not* like issues created for:
5353

5454
.. config::
55-
:fragment: gitea
55+
:fragment: forgejo
5656

57-
gitea.exclude_repos = noisy/repository
57+
forgejo.exclude_repos = noisy/repository
5858

5959
.. hint::
6060
If you omit the repository's namespace, bugwarrior will automatically add
6161
your login as namespace. E.g. the following are equivalent:
6262

6363
.. config::
64-
:fragment: gitea
64+
:fragment: forgejo
6565

66-
gitea.login = foo
67-
gitea.include_repos = bar
66+
forgejo.login = foo
67+
forgejo.include_repos = bar
6868

6969
and:
7070

7171
.. config::
72-
:fragment: gitea
72+
:fragment: forgejo
7373

74-
gitea.login = foo
75-
gitea.include_repos = foo/bar
74+
forgejo.login = foo
75+
forgejo.include_repos = foo/bar
7676

7777
Alternatively, you can use project IDs instead of names by prefixing the
7878
project id with `id:`:
7979

8080
.. config::
81-
:fragment: gitea
81+
:fragment: forgejo
8282

83-
gitea.include_repos = id:1234,id:3141
83+
forgejo.include_repos = id:1234,id:3141
8484

8585
Import Labels as Tags
8686
+++++++++++++++++++++
8787

88-
The gitea issue tracker allows you to attach labels to issues; to
88+
The forgejo issue tracker allows you to attach labels to issues; to
8989
use those labels as tags, you can use the ``import_labels_as_tags``
9090
option:
9191

9292
.. config::
93-
:fragment: gitea
93+
:fragment: forgejo
9494

95-
gitea.import_labels_as_tags = True
95+
forgejo.import_labels_as_tags = True
9696

9797
Also, if you would like to control how these labels are created, you can
98-
specify a template used for converting the gitea label into a Taskwarrior
98+
specify a template used for converting the forgejo label into a Taskwarrior
9999
tag.
100100

101-
For example, to prefix all incoming labels with the string 'gitea_' (perhaps
101+
For example, to prefix all incoming labels with the string 'forgejo_' (perhaps
102102
to differentiate them from any existing tags you might have), you could
103103
add the following configuration option:
104104

105105
.. config::
106-
:fragment: gitea
106+
:fragment: forgejo
107107

108-
gitea.label_template = gitea_{{label}}
108+
forgejo.label_template = forgejo_{{label}}
109109

110110
In addition to the context variable ``{{label}}``, you also have access
111111
to all fields on the Taskwarrior task if needed:
@@ -117,33 +117,33 @@ to all fields on the Taskwarrior task if needed:
117117

118118
Limit Issues Imported
119119
+++++++++++++++++++++
120-
Gitea lets system administrators configure the amount of objects that any given API request will return.
121-
You may configure the amount to tell Gitea to give to you using the ``issue_limit`` option:
120+
Forgejo lets system administrators configure the amount of objects that any given API request will return.
121+
You may configure the amount to tell Forgejo to give to you using the ``issue_limit`` option:
122122

123123
.. config::
124-
:fragment: gitea
124+
:fragment: forgejo
125125

126-
gitea.issue_limit = 200
126+
forgejo.issue_limit = 200
127127

128-
Do note, this will not overwrite what the gitea instance limits you to, it merely lets you set the amount of issues you will import.
128+
Do note, this will not overwrite what the forgejo instance limits you to, it merely lets you set the amount of issues you will import.
129129

130130

131131
Including various types of issues
132132
+++++++++++++++++++++
133133

134-
Gitea has metadata attached to each issue, primarily: If you are assigned to an issue, if you created an issue, if an issue mentions you, and if an issue has a review reqest for you. You may set if each of these traits is worth importing by using the various ``include_*_issues`` options:
134+
Forgejo has metadata attached to each issue, primarily: If you are assigned to an issue, if you created an issue, if an issue mentions you, and if an issue has a review reqest for you. You may set if each of these traits is worth importing by using the various ``include_*_issues`` options:
135135

136136
.. config::
137-
:fragment: gitea
137+
:fragment: forgejo
138138

139-
gitea.include_assigned_issues = true
140-
gitea.include_created_issues = true
141-
gitea.include_mentioned_issues = true
142-
gitea.include_review_requested_issues = true
139+
forgejo.include_assigned_issues = true
140+
forgejo.include_created_issues = true
141+
forgejo.include_mentioned_issues = true
142+
forgejo.include_review_requested_issues = true
143143

144144
Each setting will query the API for that trait alone and then add it to your Taskwarrior task list. For example, if you have created issues and mentioned issues off, but assigned issues and review requested issues on: You will only recieve new tasks for the issues you are assigned to do or requested to review, but not for issues you've created or mentioned. Issues that have been assigned to you and created by you would be included though, as these settings merely mark inclusion, not exclusion.
145145

146146
Provided UDA Fields
147147
-------------------
148148

149-
.. udas:: bugwarrior.services.gitea.GiteaIssue
149+
.. udas:: bugwarrior.services.forgejo.ForgejoIssue

0 commit comments

Comments
 (0)