grunt-confluence-attachments

Grunt plugin to upload attachments to confluence pages

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-confluence-attachments --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-confluence-attachments');

The "confluence_attachments" task

Overview

In your project's Gruntfile, add a section named confluence_attachments to the data object passed into grunt.initConfig().

grunt.initConfig({
  confluence_attachments: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.baseUrl

Type: String

Required

Base url of the confluence server (e.g. 'https://myserver.com')

options.pageId

Type: String

Required

Upload destination: the id of a confluence page

Usage Examples

Upload

Attach all files in a folder to the confluence page which id is 12345

grunt.initConfig({
  confluence_attachments: {
    options: {
      baseUrl: 'https://myserver.com',
      pageId: '12345'
    },
    src: 'path/to/folder/*',
  },
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)