Generates a metadata package (package.xml
& source files) for differences between two branches/commits.
Run sfdx plugins:install sfdx-git-packager
Currently supports:
- ApexClass
- ApexTrigger
- VisualForce
- Aura
- LWC
- CustomObject
- CustomField
- StaticResources
- all other simple *-meta.xml files
- Destructive Changes!
Not yet supported:
- ??? (please submit an issue if you run into anything else)
- Windows (needs testing)
Must be run from inside an sfdx project with an initialized git repo.
sfdx git:package -d <string> [-s <string>] [-t <string>] [-w] [--purge] [--nodelete] [-f] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Generates a Metadata Package using the differences between two git refs (branch or commit)
USAGE
$ sfdx git:package -d <string> [-s <string>] [-t <string>] [-w] [--purge] [--nodelete] [-f] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --outputdir=outputdir (required) The directory to output
the generated package and metadata
to
-f, --force Continue even if source is behind
target
-s, --sourceref=sourceref [default: head] The git ref (branch
or commit) which we are deploying
from. If left blank, will use head
-t, --targetref=targetref [default: master] The git ref
(branch or commit) which we are
deploying into. Defaults to master
-w, --ignorewhitespace Don't package changes that are
whitespace only
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--nodelete Don't generate
destructiveChanges.xml for deletions
--purge Delete output dir if it already
exists (without prompt)
EXAMPLES
$ sfdx git:package -s my-awesome-feature -t master -d deploy/my-feature
$ sfdx git:package -d deploy/my-feature
$ sfdx git:package -s feature-b -d deploy/feature-b
See code: lib/commands/git/package.js
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
. You can add globs to prevent source path from being picked up.
(NPM
based install coming soon)
- git clone
- cd
yarn/npm
installsfdx plugins:link
npm test
just runs the basic test suite, not much here yet
npm run integrationTest
runs integration test suite
We've got a git repo in test/integration/project
that represents a project. In order to avoid conflicts with the parent repo folders we change the .git folder to .notgit so we can commit those to the repo. You'll need to "unpack" that repo if you want to easily work in the test git repo when expanding the integration suite.
To add tests
- unpack the test repo
npm run tgu
- go to the test project
cd test/integration/project
- run
git reset --hard
to bring everything back - create a branch off of
master
, make the mods you want to test, and commit - generate the expected output
npm run gen
- check the contents of
test/integration/output
matches what you'd expect for your change (make sure to check there are no other unexpected changes!) - pack the test repo back up
npm run tgp
THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.