Skip to content

Commit

Permalink
Merge branch 'master' of github.com:ChuckJonas/sfdx-git-packager
Browse files Browse the repository at this point in the history
  • Loading branch information
ChuckJonas committed Oct 21, 2019
2 parents 968260f + 93fc807 commit ec14b8e
Showing 1 changed file with 20 additions and 10 deletions.
30 changes: 20 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
# sfdx-git-packager

![npm](https://img.shields.io/npm/v/sfdx-git-packager)

Generates a metadata package (`package.xml` & source files) for differences between two branches/commits.

![Generating vs working tree](https://user-images.githubusercontent.com/5217568/65200914-e587ed80-da45-11e9-917d-a63a3c91b29f.gif)
*Example Generating vs "working tree" & master*

## Install

Run `sfdx plugins:install sfdx-git-packager`

## Features

**Currently supports:**

- ApexClass
Expand All @@ -16,20 +24,12 @@ Generates a metadata package (`package.xml` & source files) for differences betw
- CustomField
- StaticResources
- all other simple *-meta.xml files
- Destructive Changes!

**Not yet supported:**

- ??? (please submit an issue if you run into anything else)
- Windows :/ (help wanted)

## Installation

(`NPM` based install coming soon)

1. git clone
1. cd
1. `yarn/npm` install
1. `sfdx plugins:link`
- Windows (needs testing)

## Usage

Expand Down Expand Up @@ -90,6 +90,16 @@ _See code: [lib/commands/git/package.js](https://github.com/ChuckJonas/sfdx-git-

If you wish to prevent certain files from being included in a package, you can create a `.packageIgnore` in the root of your project. This works similar to [`.gitIgnore`](https://git-scm.com/docs/gitignore). You can add globs to prevent source path from being picked up.

## Developing

(`NPM` based install coming soon)

1. git clone
1. cd
1. `yarn/npm` install
1. `sfdx plugins:link`



## Disclaimer

Expand Down

0 comments on commit ec14b8e

Please sign in to comment.