Import

Summary

The GitHub Issue Import Pod imports all the issues of a GitHub repository into your selected vault as notes. The import config has additional options to select the owner, repository, and status of the GitHub issues.

Authentication

To communicate with the GitHub server, you'll need an OAuth token with the right scopes. Follow the steps in Creating a personal access token to create a token. The scopes you require depends on the type of data you're trying to request, you can even select all and you are good to go.

Example

  • config
vaultName: vault
owner: dendronhq
repository: dendron-site
status: open
endDate: 2021-06-29
token: ***
fname: github.issues.dendron-site
  • Original
└── vault
    └── projects
          ├─one.md
          ├─two.md
  
  • After
  └── vault
        ├── projects.one.md
        ├── projects.two.md
        └── github.issues.dendron-site.86-extra-quotes-in-links-tutorial.md

  • Imported Issue
...

title: 86-Extra quotes in links tutorial
url: 'https://github.com/dendronhq/dendron-site/issues/86'
status: OPEN
issueID: gkdskrereidnYu
author: 'https://github.com/jeffbarr'
tags: 
  - area.misc
  - question
---
Line 12 of the links page ( https://github.com/dendronhq/dendron-site/edit/master/vault/dendron.tutorial.links.md ) has two consecutive back-quotes before the [[  that do not appear to be necessary. I am not sufficiently confident of this to submit a PR, however.

Configuration

src

  • description: "Where to import from"
  • type: "string" as const
  • required: true

vaultName

  • description: "name of vault to import into"
  • type: "string" as const
  • required: true

concatenate

  • description: "whether to concatenate everything into one note"
  • type: "boolean"
  • default: false

When importing, you can either import everything from source as multiple files or concatenate it all together as one file

frontmatter

  • description: "frontmatter to add to each note"
  • type: "object"

You can add custom frontmatter to notes as you import them. This is useful for example, when you want to set custom publishing options for imported notes

fnameAsId

  • description: "use the file name as the id"
  • type: "boolean"

By default, random uuids are generated as the id for each imported note. This makes the id equivalent to that of the filename

destName

  • description: "If concatenate option is set, this is the name of the destination path
  • type: "string" as const

owner

  • description: owner of the repository
  • type: string
  • required: true

repository

  • description: GitHub repository to import from
  • type: string
  • required: true

status

  • description: status of issue : open/closed
  • type: string
  • required: true

endDate

  • description: import issues created before this date
  • type: string
  • default: Today's date
  • format: YYYY-MM-DD

startDate

  • description: import issues created after this date: YYYY-MM-DD
  • type: string
  • format: YYYY-MM-DD

token

  • description: GitHub personal access token
  • type: string
  • required: true

fname

  • description: name of hierarchy to import into
  • type: string
  • required: true

Backlinks