Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 40 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,59 @@
# GitHub Issues for Obsidian
# GitHub & GitLab Issues for Obsidian

An Obsidian plugin that integrates with GitHub to track issues and pull requests directly in your vault.
![GitHub Release](https://img.shields.io/github/v/release/LonoxX/obsidian-github-issues)
![GitHub License](https://img.shields.io/github/license/LonoxX/obsidian-github-issues)
![GitHub Last Commit](https://img.shields.io/github/last-commit/LonoxX/obsidian-github-issues)
![Release Workflow](https://img.shields.io/github/actions/workflow/status/LonoxX/obsidian-github-issues/release.yml?label=release)
![Obsidian Downloads](https://img.shields.io/badge/dynamic/json?logo=obsidian&color=%23483699&label=downloads&query=%24%5B%22github-issues%22%5D.downloads&url=https://raw.githubusercontent.com/obsidianmd/obsidian-releases/master/community-plugin-stats.json)
![GitHub Stars](https://img.shields.io/github/stars/LonoxX/obsidian-github-issues)
![GitHub Issues](https://img.shields.io/github/issues/LonoxX/obsidian-github-issues)

An Obsidian plugin that integrates with GitHub and GitLab to track issues and pull requests directly in your vault.

>The configurations are heavily inspired by https://github.com/schaier-io, including some specific settings. However, I had already started working on my prototype before I discovered the plugin, and had initially even given it a similar name.
> The configurations are heavily inspired by https://github.com/schaier-io, including some specific settings. However, I had already started working on my prototype before I discovered the plugin, and had initially even given it a similar name.

# Documentation

Check out the [documentation](https://github.com/LonoxX/obsidian-github-issues/wiki) for detailed information on setup, configuration, and usage.

## Features

### Issue & Pull Request Tracking
- Track issues and pull requests from multiple GitHub repositories
- Automatically sync GitHub data on startup (configurable)

- Track issues and pull requests from multiple GitHub and GitLab repositories
- Automatically sync data on startup (configurable)
- Background sync at configurable intervals
- Filter by labels, assignees, and reviewers
- Include or exclude closed issues/PRs
- Automatic cleanup of old closed items

### GitLab Support

- Full support for GitLab Issues and Merge Requests
- Works with self-hosted GitLab instances
- Multiple GitLab instances can be configured simultaneously

### GitHub Projects v2 Integration

- Track GitHub Projects across repositories
- Kanban board view for project visualization
- Custom field support (status, priority, iteration)
- Project-specific filtering and organization

### Sub-Issues Support
- Track GitHub sub-issues (parent/child relationships)

- Track sub-issues for both GitHub and GitLab (parent/child relationships)
- Display sub-issues list with status indicators
- Navigate between parent and child issues
- Progress tracking with completion percentage

### Settings Profiles

- Central configuration for folders, templates, sync behaviour, and filters
- Assign one profile to multiple repositories instead of configuring each one individually

### Markdown Notes

- Create markdown notes for each issue or PR
- Customizable filename templates with variables
- Custom content templates
Expand All @@ -54,19 +77,24 @@ Check out the [documentation](https://github.com/LonoxX/obsidian-github-issues/w
3. Enable the plugin in **Community Plugins**
4. Reload Obsidian


## Configuration

1. Create a new GitHub token with the `repo` and `read:org` permissions
### GitHub

1. Create a GitHub token with `repo` and `read:org` permissions
→ [GitHub Settings > Developer Settings > Personal access tokens](https://github.com/settings/tokens)
2. Configure the plugin in Obsidian settings:
- Paste your GitHub token in the **GitHub Token** field
- Adjust additional settings as needed
2. Paste the token in **Settings - Providers - GitHub Token**

### GitLab

1. Create a GitLab Personal Access Token with `read_api` scope
→ GitLab → Preferences → Access Tokens
2. Enable the GitLab provider in **Settings - Providers - GitLab Token** and paste your token

## Adding Repositories

1. Open the plugin settings in Obsidian
2. Add repositories by entering the full GitHub repository path (e.g., `lonoxx/obsidian-github-issues`),
2. Add repositories by entering the full repository path (e.g., `lonoxx/obsidian-github-issues`),
or use the repository browser to select one or multiple repositories
3. Click **Add Repository** or **Add Selected Repositories**
4. The plugin will automatically fetch issues from the configured repositories
Expand Down
4 changes: 2 additions & 2 deletions manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
"name": "Github Issues",
"version": "1.8.0",
"minAppVersion": "0.15.0",
"description": "Track Github Issues and pull requests directly in your vault",
"description": "Track GitHub Issues, Pull Requests, GitLab Issues and Merge Requests directly in your vault",
"author": "LonoxX",
"authorUrl": "https://github.com/LonoxX",
"isDesktopOnly": false,
"fundingUrl": {
"GitHub Sponsor": "https://github.com/sponsors/LonoxX",
"Ko-fi": "https://ko-fi.com/LonoxX"
}
}
}
14 changes: 8 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "github-issues",
"version": "1.8.0",
"description": "Track GitHub issues and pull requests in Obsidian",
"version": "1.8.0",
"description": "Track GitHub and GitLab issues and pull/merge requests in Obsidian",
"main": "main.js",
"scripts": {
"dev": "node esbuild.config.mjs",
Expand All @@ -12,17 +12,19 @@
"keywords": [
"obsidian",
"github",
"gitlab",
"tracker",
"issues",
"pull-requests"
"pull-requests",
"merge-requests"
],
"author": "LonoxX",
"license": "MIT",
"devDependencies": {
"@types/node": "^25.3.0",
"@types/node": "^25.5.0",
"builtin-modules": "^5.0.0",
"esbuild": "^0.27.3",
"obsidian": "^1.12.2",
"esbuild": "^0.27.4",
"obsidian": "^1.12.3",
"prettier": "^3.8.1",
"tslib": "^2.8.1",
"typescript": "^5.9.3"
Expand Down
Loading
Loading