Swap to jerryjvl build repo

README.md

@@ -1,44 +1,46 @@
-# Jekyll action
-[![License](https://img.shields.io/badge/%E2%9A%96%EF%B8%8F-CC%20BY%204.0-brightgreen)](https://creativecommons.org/licenses/by/4.0)
+# jekyll-build-action
+Plain in-place Jekyll build action to be used in pipelines with a variety of possible deploy targets.
 
-This action provides just Jekyll and some basic build tools ([Alpine's `build-base`](https://pkgs.alpinelinux.org/package/v3.3/main/x86/build-base)).
-It's based on the [jekyll/minimal:latest](https://github.com/envygeeks/jekyll-docker) [Docker](https://docker.com) image and the [jerryjvl/jekyll-build-action](https://github.com/jerryjvl/jekyll-build-action).
+# Usage
+This Action literally only invokes a Jekyll build, so your pipeline needs to ensure the Jekyll source is first gathered, and once this action completes you must copy the contents of the destination folder to your intended hosting location.
 
-## Usage
+A typical example would be a GitHub repository with Jekyll source, and publishing the output to an S3 bucket configured for static site hosting.
+
+The pipeline to realize this would look something like the following:
 ```yaml
 jobs:
   jekyll:
-    name: Build and store Jekyll site
+    name: Build and deploy Jekyll site
     runs-on: ubuntu-latest
+
     steps:
-      - name: Checkout 📥
-        uses: actions/checkout@v2.3.4
-        with:
-          lfs: true
-          fetch-depth: 1
+    - name: Checkout
+      uses: actions/checkout@v2
 
-      - name: Build ⚙️
-        uses: vivi90/jekyll-minimal-action@v1.1.0
-        with:
-          command: jekyll build
+    - name: Build
+      uses: jerryjvl/jekyll-build-action@v1
 
-      - name: Store 📦
-        uses: actions/upload-artifact@v2.2.4
-        if: success()
-        with:
-          name: site
-          path: _site
+    - name: Configure AWS credentials
+      uses: aws-actions/configure-aws-credentials@v1
+      with:
+        aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+        aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        aws-region: us-east-1
+
+    - name: Sync output to S3
+      run: |
+        aws s3 sync ./_site/ s3://my-s3-bucket --delete
 ```
-Just use the `command` option as you like:
- - `jekyll build --trace`
- - `jekyll serve`
- - and so on..
 
-## Contribution
-Please feel free to create issues and/or pull requests.
+# References
+For more technical details on these steps and associated setup, see:
+- [actions/checkout](https://github.com/actions/checkout)
+- [aws-actions/configure-aws-credentials](https://github.com/aws-actions/configure-aws-credentials)
+- [Creating encrypted secrets in GitHub](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets)
 
-## License
-This project is free software under the terms of the CC BY 4.0 license.
-For more details please see the LICENSE file or: [Creative Commons](http://creativecommons.org/licenses/by/4.0)
+# A Note on Security
+Please be mindful of the third-party actions you trust with your secrets, credentials and content. Without investigation you should assume a third-party action might exfiltrate your content to some secondary location, or modify contents before they are published.
 
-*The licenses of the installed components may differ.*
+Futhermore, if you rely on versioning that the publisher of an action can control, the action you think you are running could be changed later without your knowledge.
+
+... Trust but verify!