Merge pull request #7 from datalust/dev

Release

Author: nblumhardt

Build.ps1

@@ -47,10 +47,37 @@ function Execute-Tests
     popd
 }
 
-function Publish-Artifacts($version)
+function Create-ArtifactDir
 {
 	mkdir ./artifacts
-	mv ./setup/Datalust.Piggy.Setup/bin/Release/piggy.msi ./artifacts/piggy-$version-pre.msi
+}
+
+function Publish-Gzips($version)
+{
+	$rids = @("ubuntu.14.04-x64", "ubuntu.16.04-x64", "rhel.7-x64", "osx.10.12-x64")
+	foreach ($rid in $rids) {
+		& dotnet publish src/Datalust.Piggy/Datalust.Piggy.csproj -c Release -r $rid
+	    if($LASTEXITCODE -ne 0) { exit 3 }
+	
+		# Make sure the archive contains a reasonable root filename
+		mv ./src/Datalust.Piggy/bin/Release/netcoreapp1.1/$rid/publish/ ./src/Datalust.Piggy/bin/Release/netcoreapp1.1/$rid/piggy-$version-$rid/
+
+		& ./build/7-zip/7za.exe a -ttar piggy-$version-$rid.tar ./src/Datalust.Piggy/bin/Release/netcoreapp1.1/$rid/piggy-$version-$rid/
+		if($LASTEXITCODE -ne 0) { exit 3 }
+
+		# Back to the original directory name
+		mv ./src/Datalust.Piggy/bin/Release/netcoreapp1.1/$rid/piggy-$version-$rid/ ./src/Datalust.Piggy/bin/Release/netcoreapp1.1/$rid/publish/
+		
+		& ./build/7-zip/7za.exe a -tgzip ./artifacts/piggy-$version-$rid.tar.gz piggy-$version-$rid.tar
+		if($LASTEXITCODE -ne 0) { exit 3 }
+
+		rm piggy-$version-$rid.tar
+	}
+}
+
+function Publish-Msi($version)
+{
+	mv ./setup/Datalust.Piggy.Setup/bin/Release/piggy.msi ./artifacts/piggy-$version.msi
 }
 
 Push-Location $PSScriptRoot
@@ -63,6 +90,8 @@ Update-AssemblyInfo($version)
 Update-WixVersion($version)
 Execute-MSBuild
 Execute-Tests
-Publish-Artifacts($version)
+Create-ArtifactDir
+Publish-Gzips($version)
+Publish-Msi($version)
 
 Pop-Location

README.md

@@ -2,27 +2,29 @@
 
 A friendly PostgreSQL script runner in the spirit of [DbUp](https://github.com/DbUp/DbUp).
 
-[![Build status](https://ci.appveyor.com/api/projects/status/889gkdpvjbjuhkfg?svg=true)](https://ci.appveyor.com/project/datalust/piggy)
+[![Build status](https://ci.appveyor.com/api/projects/status/889gkdpvjbjuhkfg?svg=true)](https://ci.appveyor.com/project/datalust/piggy)  [![Join the chat at https://gitter.im/datalust/piggy](https://img.shields.io/gitter/room/datalust/piggy.svg)](https://gitter.im/datalust/piggy)
 
 ### What is Piggy?
 
 Piggy is a simple command-line tool for managing schema and data changes to PostgreSQL databases. Piggy looks for `.sql` files in a directory and applies them to the database in order, using transactions and a change log table to ensure each script runs only once per database.
 
 ### Installation
 
-Piggy is available as a Windows MSI installer from [the releases page](https://github.com/datalust/piggy/releases). Linux and macOS are supported, but currently require the `Datalust.Piggy` project in this repository to be built from source.
+Piggy is available for Windows, macOS and Linux from [the releases page](https://github.com/datalust/piggy/releases). Download the MSI or archive file for [your platform](https://docs.microsoft.com/en-us/dotnet/core/rid-catalog). If your platform of choice isn't listed, please [raise an issue here](https://github.com/datalust/piggy/issues) so that we can add it.
 
-### Organizing change scripts
+### Workflow
 
-Your `.sql` files should be named so that they will sort lexicographically in the order they need to be executed:
+To manage database updates with Piggy, write SQL scripts to make changes, rather than applying changes directly.
+
+Organize change scripts on the file system under a _script root_ directory. Name files so that they sort lexicographically in the order in which they need to be executed:
 
 ```
 001-create-schema.sql
 002-create-users-table.sql
 003-...
 ```
 
-If the scripts are arranged in subfolders, these can be ordered as well:
+If the scripts are arranged in subdirectories, these must be ordered by name as well:
 
 ```
 v1/
@@ -33,21 +35,21 @@ v2/
   001-rename-users-table.sql
 ```
 
-Each script is just regular SQL with any DDL or DML statements required to make a change to the database.
-
-### Applying scripts
-
-Scripts must be applied starting from a _script root_. Piggy searches for `.sql` files and generates script names like `/v1/001-create-schema.sql` using each script's filename relative to the script root. These relative filenames are checked against the change log table to determine which of them need to be run.
+Piggy enumerates `.sql` files and generates names like `/v1/001-create-schema.sql` using each script's filename relative to the script root. These relative names are checked against the change log table to determine which of them need to be run.
 
-The script root is specified with `-s`. Other parameters identify the database server host, the database name, username and password:
+To bring a database up to date, run `piggy up`, providing the script root, host, database name, username and password:
 
 ```
-piggy apply -s <scripts> -h <host> -d <database> -u <username> -p <password>
+piggy up -s <scripts> -h <host> -d <database> -u <username> -p <password>
 ```
 
 If the database does not exist, Piggy will create it using sensible defaults. To opt out of this behavior, add the `--no-create` flag.
 
-For more detailed usage information, run `piggy help apply`; to see all available commands run `piggy help`.
+Over time, as your application grows, create new scripts to move the database forwards - don't edit the existing ones, since they've already been applied and will be ignored by Piggy.
+
+Piggy can be used to update from any previous schema version to the current one: scripts that have already been run on a database are ignored, so only necessary scripts are applied.
+
+For more detailed usage information, run `piggy help up`; to see all available commands run `piggy help`.
 
 ### Transactions
 
@@ -64,7 +66,7 @@ as the first line of the script.
 Piggy uses `$var$` syntax for replaced variables:
 
 ```sql
-create table $schema$.users;
+create table $schema$.users (name varchar(140) not null);
 insert into users (name) values ('$admin$');
 ```
 
@@ -73,9 +75,9 @@ Values are inserted using pure text substitution: no escaping or other processin
 Variables are supplied on the command-line with the `-v` flag:
 
 ```
-piggy apply ... -v schema=myapp -v admin=myuser
+piggy up ... -v schema=myapp -v admin=myuser
 ```
 
 ### Change log
 
-The change log is stored in the target database in `piggy.changes`. The `piggy log` command can be used to view applied change scripts.
+The change log is stored in the target database in `piggy.changes`. The `piggy log` command is used to view applied change scripts.

appveyor.yml

@@ -5,12 +5,13 @@ build_script:
 - ps: ./Build.ps1
 test: off
 artifacts:
-- path: artifacts/*.msi
+- path: artifacts/piggy-*.msi
+- path: artifacts/piggy-*.tar.gz
 deploy:
 - provider: GitHub
   auth_token:
     secure: Bo3ypKpKFxinjR9ShkNekNvkob2iklHJU+UlYyfHtcFFIAa58SV2TkEd0xWxz633
-  artifact: /piggy-.*\.msi/
+  artifact: /piggy-.*\.(msi|tar\.gz)/
   tag: v$(appveyor_build_version)
   on:
     branch: master

build/7-zip/7za.dll

@@ -0,0 +1,85 @@
+.Language=English,English
+.PluginContents=7-Zip Plugin
+
+@Contents
+$^#7-Zip Plugin 16.04#
+$^#Copyright (c) 1999-2016 Igor Pavlov#
+    This FAR module performs transparent #archive# processing.
+Files in the archive are handled in the same manner as if they
+were in a folder.
+
+   ~Extracting from the archive~@Extract@
+
+   ~Add files to the archive~@Update@
+
+   ~7-Zip Plugin configuration~@Config@
+
+
+ Web site:  #www.7-zip.org#
+
+@Extract
+$ #Extracting from the archive#
+
+In this dialog you may enter extracting mode.
+
+          Path mode
+
+  #Full pathnames#       Extract files with full pathnames.
+
+  #Current pathnames#    Extract files with all relative paths.
+
+  #No pathnames#         Extract files without folder paths.
+
+
+          Overwrite mode
+
+  #Ask before overwrite#       Ask before overwriting existing files.
+
+  #Overwrite without prompt#   Overwrite existing files without prompt.
+
+  #Skip existing files#        Skip extracting of existing files.
+
+
+           Files
+
+  #Selected files#    Extract only selected files.
+
+  #All files#         Extract all files from archive.
+
+@Update
+$ #Add files to the archive#
+
+This dialog allows you to specify options for process of updating archive.
+
+
+      Compression method
+
+  #Store#     Files will be copied to archive without compression.
+
+  #Normal#    Files will be compressed.
+
+  #Maximum#   Files will be compressed with method that gives
+            maximum compression ratio.
+
+
+      Update mode
+
+  #Add and replace files#    Add all specified files to the archive.
+
+  #Update and add files#     Update older files in the archive and add
+                           files that are new to the archive.
+
+  #Freshen existing files#   Update specified files in the archive that
+                           are older than the selected disk files.
+
+  #Synchronize files#        Replace specified files only if
+                           added files are newer. Always add those
+                           files, which are not present in the
+                           archive. Delete from archive those files,
+                           which are not present on the disk.
+
+@Config
+$ #7-Zip Plugin configuration#
+    In this dialog you may change following parameters:
+
+ #Plugin is used by default#  Plugin is used by default.