Skip to content
This repository has been archived by the owner on May 9, 2021. It is now read-only.

Xcode editor extension that adds an ability to post and edit github issues through comment templates

License

Notifications You must be signed in to change notification settings

ambientlight/GithubIssuesExtension

Repository files navigation

image

Github Issues Xcode Extension

Have you even been creating github issues while coding and adding them as //TODO: into your source files? Now you won't need to leave xcode while doing that!

This extension adds github issues support to xcode editor.
Capabilities:

  • Create new github issue
  • Modify existing github issue
  • Remove all TODO: blocks that are linked to github issues if issues are already closed

Commands:

  • Create new issue template
  • Create modify issue template
  • Synchronize Issues (commits issue template to github)
  • Remove closed issues

Create New Github Issue

image

Owner and repository name are automatically inferred from the source file header. Project name is treated as a repository, while the name of the the copyright holder is treated as repository owner.

assignee parameter is optional.
Description and Title can be multiline. Empty comment line // or parameter line will end the tile, while in description, empty comment line will be treated as newlines.

Modify Existing Github Issue

image

If shouldOverrideDescription is not specified, the new description will be appended to existing one.

title, assignee, status, shouldOverrideDescription are optional.

Adding code into issue description

image

The code in between // <code> and // </code> will be present as part of the issue description. Code language (for syntax highlighting) will be derived from source file extension present in xcode generated source file header. Multiple code blocks are allowed within the same issue. The example demonstrated above will look on github in the following way:

image

App Store

Will be available later after we play enough with this initial release

Installation

  1. Clone the repo and open GithubIssuesExtension.xcodeproj
  2. Enable signing for both the Application and the Xcode Editor Extension
  3. Run Product -> Archive
  4. Open Window -> Organizer -> Right click on generated archive -> Show in Finder
  5. Right click on archive -> Show Package Contents
  6. Open Products/Applications
  7. Drag GithubIssuesExtension.app to your Applications folder.
  8. Navigate to your Github Settings (in browser).
  9. Go to Personal access token (which should be last in the list on the left)
  10. Click on Generate new token (if you don't have one already)
  11. (Optionally add repo scope if you intend to use this plugin with private repos.)
  12. Generate token and copy it.
  13. Open GithubIssuesExtension.app. Paste the token into GithubIssueExtension app and hit return.
  14. Close the app.
  15. Open System Preferences -> Extensions -> Xcode Source Editor and enable this extension.
  16. You should now be able to access the extension under Editor -> Github Issues
  17. I recommend you adding the following shortcut to this plugin commands. (Xcode -> Preferences -> Key Bindings -> search Github Issues)
  • Create New Issue Template (control + option + command + N)
  • Create Modify Issue Template (control + option + command + M)
  • Synchronize Issues (control + option + command + P)
  • Remove closed issues (control + option + command + R)

About

Xcode editor extension that adds an ability to post and edit github issues through comment templates

Resources

License

Stars

Watchers

Forks

Packages

No packages published