Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
G
GitlabRSSSync
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Iterations
Requirements
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
open-source
GitlabRSSSync
Commits
321783cd
Commit
321783cd
authored
5 years ago
by
Adam Harrison-Fuller
Browse files
Options
Downloads
Patches
Plain Diff
Adding parameter tables to the README
Signed-off-by:
Adam Harrison-Fuller
<
adam@adamhf.io
>
parent
ebf265fd
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+23
-7
23 additions, 7 deletions
README.md
with
23 additions
and
7 deletions
README.md
+
23
−
7
View file @
321783cd
...
...
@@ -21,18 +21,34 @@ The config file **MUST** be named config.yaml, an example one is provided [here]
description of its contents.
```
yaml
interval
:
300
// Interval in seconds to check the RSS feeds.
interval
:
300
feeds
:
-
id
:
test
//Specify a feed ID that is used internally for duplicate detection.
feed_url
:
http://example.com/rss.xml
// The Feed URL.
name
:
Test Feed
// A User friendly display name.
gitlab_project_id
:
12345
// The Gitlab project ID to create issues under.
added_since
:
"
2019-03-27T15:00:00Z"
// (Optional) For longer RSS feeds specify a ISO 8601 DateTime to exclude items published/updated earlier than this
labels
:
// (Optional) A list of labels to add to created Issues.
-
id
:
test
feed_url
:
http://example.com/rss.xml
name
:
Test Feed
gitlab_project_id
:
12345
added_since
:
"
2019-03-27T15:00:00Z"
labels
:
-
TestLabel
-
id
:
feed2
...
```
### Global
| Attribute | Type | Required | Description |
|-----------|------|----------|---------------------------------------------|
| interval | int | yes | The interval in seconds between feed checks |
### Feeds
| Attribute | Type | Required | Description |
|-------------------|--------|----------|-------------------------------------------------------------------------------------------------------|
| id | string | yes | A feed ID that is used internally for duplicate detection. |
| feed_url | string | yes | The URL of the feed |
| name | string | yes | A User friendly display name. |
| gitlab_project_id | int | yes | The Gitlab project ID to create issues under. |
| added_since | string | no | For longer RSS feeds specify a ISO 8601 DateTime to exclude items published/updated earlier than this |
| Labels | Array | no | A list of labels to add to created Issues |
## Docker
A Docker image is made available on
[
DockerHub
](
https://hub.docker.com/r/adamhf/gitlabrsssync
)
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment