https://github.com/fabiospampinato/autogit-plugin-github-publish

A plugin for publishing repositories to GitHub.
https://github.com/fabiospampinato/autogit-plugin-github-publish

autogit github plugin publish

Last synced: about 1 month ago
JSON representation

A plugin for publishing repositories to GitHub.

• Host: GitHub
• URL: https://github.com/fabiospampinato/autogit-plugin-github-publish
• Owner: fabiospampinato
• License: mit
• Archived: true
• Created: 2018-10-08T03:48:24.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-01-24T20:28:48.000Z (over 4 years ago)
• Last Synced: 2024-06-23T19:03:33.012Z (3 months ago)
• Topics: autogit, github, plugin, publish
• Language: TypeScript
• Size: 21.5 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Autogit Plugin - Github Publish

A plugin for publishing repositories to GitHub.

## Install

```sh

npm install --save autogit-plugin-github-publish

```

## Usage

#### Options

This plugin uses the following options object:

```js

{

  remote: 'origin', // Using this name for the newly created repository

  token: '', // GitHub token

  message: 'Initial commit', // Commit message for the initial commit, set it to false to disable this

  force: false, // Don't ask for confirmation

  private: false, // Don't publish as private

  ssh: true // Use SSH rather than HTTPS

}

```

#### Configuration

Add this plugin to a command:

```js

const publish = require ( 'autogit-plugin-github-publish' );

module.exports = {

  commands: {

    'my-command': [

      publish ({ token: 'MY_GITHUB_TOKEN' })

    ]

  }

}

```

## License

MIT © Fabio Spampinato