From 4caf843e2a264ab30e558f3fd64d5672b56315ee Mon Sep 17 00:00:00 2001 From: Daniel Thorpe Date: Mon, 10 Jul 2017 17:29:48 +0100 Subject: [PATCH 1/7] Fixes the directory - so that it matches the branch. --- .ci/build-docs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.ci/build-docs b/.ci/build-docs index 7ad47ef..4ca1bdf 100755 --- a/.ci/build-docs +++ b/.ci/build-docs @@ -26,4 +26,4 @@ bundle exec jazzy --config jazzy.json echo "--- :aws: Upload" cd "docs/" -buildkite-agent artifact upload "**/*" s3://procedure.kit.run/development +buildkite-agent artifact upload "**/*" "s3://procedure.kit.run/$PROCEDUREKIT_BRANCH" From c86208d3a4e8686721207bd144273739cb13720b Mon Sep 17 00:00:00 2001 From: Daniel Thorpe Date: Mon, 10 Jul 2017 18:30:41 +0100 Subject: [PATCH 2/7] Switches to awscli --- .ci/build-docs | 4 ++-- jazzy.json | 13 ++++++++++++- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/.ci/build-docs b/.ci/build-docs index 4ca1bdf..d301b9a 100755 --- a/.ci/build-docs +++ b/.ci/build-docs @@ -25,5 +25,5 @@ echo "--- Jazzy" bundle exec jazzy --config jazzy.json echo "--- :aws: Upload" -cd "docs/" -buildkite-agent artifact upload "**/*" "s3://procedure.kit.run/$PROCEDUREKIT_BRANCH" +echo 'aws s3 cp --recursive docs "s3://procedure.kit.run/$PROCEDUREKIT_BRANCH"' +aws s3 cp --recursive docs "s3://procedure.kit.run/$PROCEDUREKIT_BRANCH" diff --git a/jazzy.json b/jazzy.json index b258bd7..632600a 100644 --- a/jazzy.json +++ b/jazzy.json @@ -7,5 +7,16 @@ "module": "ProcedureKit", "readme": "README.md", "theme": "fullwidth", - "documentation": "Guides/*.md" + "documentation": "sources/ProcedureKit/Guides/**/*.md", + + "custom_categories": [{ + "name": "Programming Guide", + "children": [ + "What is ProcedureKit?", + "Installing", + "MyFirstProcedure", + "Scheduling", + "Dependencies" + ] + }] } \ No newline at end of file From 305be3a612c7ad3bbbff94982c078f8e5b3487a9 Mon Sep 17 00:00:00 2001 From: Daniel Thorpe Date: Mon, 10 Jul 2017 18:37:17 +0100 Subject: [PATCH 3/7] Adds more categories --- jazzy.json | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/jazzy.json b/jazzy.json index 632600a..74ffaf7 100644 --- a/jazzy.json +++ b/jazzy.json @@ -10,13 +10,37 @@ "documentation": "sources/ProcedureKit/Guides/**/*.md", "custom_categories": [{ - "name": "Programming Guide", + "name": "Getting Started", "children": [ "What is ProcedureKit?", "Installing", "MyFirstProcedure", "Scheduling", "Dependencies" - ] + ]}, { + "name": "Migrating", + "children": [ + "From NSOperation", + "From WWDC2015", + "From PSOperations", + "From ProcedureKit v3", + "From ProcedureKit v4" + ]}, { + "name": "Core Features", + "children": [ + "Observers", + "Conditions", + "Cancellation", + "Mutual Exclusivity", + "Groups", + "Result Injection" + ]}, { + "name": "Advanced Features", + "children": [ + "Capabilities", + "Logging", + "Advanced Groups", + "Advanced Result Injection" + ]} }] } \ No newline at end of file From b847befd67b121431f297e707622bff934ba8f0f Mon Sep 17 00:00:00 2001 From: Daniel Thorpe Date: Thu, 13 Jul 2017 16:55:17 +0100 Subject: [PATCH 4/7] Removes .jazzy.json --- .ci/build-docs | 7 ++++++- jazzy.json | 46 ---------------------------------------------- 2 files changed, 6 insertions(+), 47 deletions(-) delete mode 100644 jazzy.json diff --git a/.ci/build-docs b/.ci/build-docs index d301b9a..adc00ec 100755 --- a/.ci/build-docs +++ b/.ci/build-docs @@ -21,7 +21,12 @@ cd "../.." echo "bundle install --quiet" bundle install --quiet -echo "--- Jazzy" +echo "--- Jazzy ProcedureKit" + +echo "cd sources/ProcedureKit" +cd "sources/ProcedureKit" + +echo "bundle exec jazzy --config jazzy.json" bundle exec jazzy --config jazzy.json echo "--- :aws: Upload" diff --git a/jazzy.json b/jazzy.json deleted file mode 100644 index 74ffaf7..0000000 --- a/jazzy.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "xcodebuild_arguments": [ - "-project", "sources/ProcedureKit/ProcedureKit.xcodeproj", - "-scheme", "ProcedureKit"], - "author": "ProcedureKit Contributors", - "author_url": "https://github.com/ProcedureKit", - "module": "ProcedureKit", - "readme": "README.md", - "theme": "fullwidth", - "documentation": "sources/ProcedureKit/Guides/**/*.md", - - "custom_categories": [{ - "name": "Getting Started", - "children": [ - "What is ProcedureKit?", - "Installing", - "MyFirstProcedure", - "Scheduling", - "Dependencies" - ]}, { - "name": "Migrating", - "children": [ - "From NSOperation", - "From WWDC2015", - "From PSOperations", - "From ProcedureKit v3", - "From ProcedureKit v4" - ]}, { - "name": "Core Features", - "children": [ - "Observers", - "Conditions", - "Cancellation", - "Mutual Exclusivity", - "Groups", - "Result Injection" - ]}, { - "name": "Advanced Features", - "children": [ - "Capabilities", - "Logging", - "Advanced Groups", - "Advanced Result Injection" - ]} - }] -} \ No newline at end of file From e21606e8fe146fcf824ac3ed2b185f3150f87e66 Mon Sep 17 00:00:00 2001 From: Daniel Thorpe Date: Thu, 13 Jul 2017 18:09:59 +0100 Subject: [PATCH 5/7] Fixes path to .jazzy.json --- .ci/build-docs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.ci/build-docs b/.ci/build-docs index adc00ec..c01508c 100755 --- a/.ci/build-docs +++ b/.ci/build-docs @@ -26,8 +26,8 @@ echo "--- Jazzy ProcedureKit" echo "cd sources/ProcedureKit" cd "sources/ProcedureKit" -echo "bundle exec jazzy --config jazzy.json" -bundle exec jazzy --config jazzy.json +echo "bundle exec jazzy --config .jazzy.json" +bundle exec jazzy --config .jazzy.json echo "--- :aws: Upload" echo 'aws s3 cp --recursive docs "s3://procedure.kit.run/$PROCEDUREKIT_BRANCH"' From ef4f760eed7899239536b55a8044003aa2074c9d Mon Sep 17 00:00:00 2001 From: Daniel Thorpe Date: Thu, 13 Jul 2017 23:52:39 +0100 Subject: [PATCH 6/7] Uses S3 sync --- .ci/build-docs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.ci/build-docs b/.ci/build-docs index c01508c..9f86f45 100755 --- a/.ci/build-docs +++ b/.ci/build-docs @@ -30,5 +30,5 @@ echo "bundle exec jazzy --config .jazzy.json" bundle exec jazzy --config .jazzy.json echo "--- :aws: Upload" -echo 'aws s3 cp --recursive docs "s3://procedure.kit.run/$PROCEDUREKIT_BRANCH"' -aws s3 cp --recursive docs "s3://procedure.kit.run/$PROCEDUREKIT_BRANCH" +echo 'aws s3 sync --acl public-read docs "s3://procedure.kit.run/$PROCEDUREKIT_BRANCH"' +aws s3 sync --acl public-read docs "s3://procedure.kit.run/$PROCEDUREKIT_BRANCH" From 958e498131bb6032219d3ce86223e883d951e91b Mon Sep 17 00:00:00 2001 From: swiftlyfalling Date: Tue, 8 May 2018 09:57:10 -0400 Subject: [PATCH 7/7] CLI Enhancements (#4) * AWS S3 Upload: Add --delete flag Ensures that the destination (the S3 path) matches source exactly (by removing any files that do not exist in source). * Jazzy: Add --clean flag Ensure that Jazzy cleans the output (docs) directory when run. * Jazzy: Explicitly specify the expected output directory --- .ci/build-docs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.ci/build-docs b/.ci/build-docs index 9f86f45..4406af0 100755 --- a/.ci/build-docs +++ b/.ci/build-docs @@ -26,9 +26,9 @@ echo "--- Jazzy ProcedureKit" echo "cd sources/ProcedureKit" cd "sources/ProcedureKit" -echo "bundle exec jazzy --config .jazzy.json" -bundle exec jazzy --config .jazzy.json +echo "bundle exec jazzy --clean --output docs --config .jazzy.json" +bundle exec jazzy --clean --output docs --config .jazzy.json echo "--- :aws: Upload" -echo 'aws s3 sync --acl public-read docs "s3://procedure.kit.run/$PROCEDUREKIT_BRANCH"' -aws s3 sync --acl public-read docs "s3://procedure.kit.run/$PROCEDUREKIT_BRANCH" +echo 'aws s3 sync docs "s3://procedure.kit.run/$PROCEDUREKIT_BRANCH" --acl public-read --delete' +aws s3 sync docs "s3://procedure.kit.run/$PROCEDUREKIT_BRANCH" --acl public-read --delete