diff --git a/.github/workflows/push-prebuild.yml b/.github/workflows/push-prebuild.yml deleted file mode 100644 index 63d9647..0000000 --- a/.github/workflows/push-prebuild.yml +++ /dev/null @@ -1,34 +0,0 @@ -name: Push pre-built action - -on: - push: - branches: - - '**' - -jobs: - build_and_push: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v2 - - - name: Output branch name - id: name - run: echo "##[set-output name=branch;]${GITHUB_REF#refs/heads/}" - - - name: Push - uses: satackey/push-prebuilt-action@v0.1 - with: - push-branch: release-${{ steps.name.outputs.branch }} - docker-registry: docker.io - docker-user: satackey - docker-token: ${{ secrets.DOCKERHUB_TOKEN }} - docker-repotag: docker.io/satackey/action-google-drive:${{ github.sha }} - - - name: Update latest tag - if: github.ref == 'refs/heads/master' - run: | - docker tag \ - docker.io/satackey/action-google-drive:${{ github.sha }} \ - docker.io/satackey/action-google-drive:latest - docker push docker.io/satackey/action-google-drive:latest diff --git a/Dockerfile b/Dockerfile deleted file mode 100644 index 42e60b2..0000000 --- a/Dockerfile +++ /dev/null @@ -1,10 +0,0 @@ -FROM satackey/skicka - -# RUN mv /root /github/home - -WORKDIR /src -COPY entrypoint.sh ./ -ENTRYPOINT /src/entrypoint.sh - -WORKDIR /work -VOLUME ["/work"] \ No newline at end of file diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 261eeb9..0000000 --- a/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/README.md b/README.md deleted file mode 100644 index 2c1d3fb..0000000 --- a/README.md +++ /dev/null @@ -1,118 +0,0 @@ -# Upload to Google Drive - -This action uploads the specified directory/files to Google Drive. - -## Example - -### Upload - -```yaml -- name: Upload to Google Drive - uses: satackey/action-google-drive@v1 - with: - skicka-tokencache-json: ${{ secrets.SKICKA_TOKENCACHE_JSON }} - upload-from: ./ - upload-to: /path/to/upload - - # For those who set up Google Drive API client ID and secret themselves - google-client-id: ${{ secrets.GOOGLE_CLIENT_ID }} - google-client-secret: ${{ secrets.GOOGLE_CLIENT_SECRET }} -``` - -### Donwload - -```yaml -- name: Download from Google Drive - uses: satackey/action-google-drive@v1 - with: - skicka-tokencache-json: ${{ secrets.SKICKA_TOKENCACHE_JSON }} - download-from: /path/to/download - download-to: ./ - - # For those who set up Google Drive API client ID and secret themselves - google-client-id: ${{ secrets.GOOGLE_CLIENT_ID }} - google-client-secret: ${{ secrets.GOOGLE_CLIENT_SECRET }} -``` - -## Get ready - -This action uses [`skicka`](https://github.com/google/skicka) for uploading to Google Drive. -You need to generate token and register it with GitHub secrets. - -### How to generate token - -#### Users already using skicka - -In your GitHub repository → Settings → Secrets, register by entering `SKICKA_TOKENCACHE_JSON` for name and the content of `~/.skicka.tokencache.json` for value. - -#### Users who have never used `skicka` - -1. Setup Docker and execute following command. - ```sh - docker run --rm -it --entrypoint "" satackey/skicka sh -c "skicka -no-browser-auth ls && cat /root/.skicka.tokencache.json" - ``` -1. Access the URL showed in the output -1. Grant access, paste code showed in the browser into the terminal. -1. In your GitHub repository → Settings → Secrets, register by entering `SKICKA_TOKENCACHE_JSON` for name and the content of `~/.skicka.tokencache.json` for value. - - ```json - {"ClientId":"xxx-xxxxx.apps.googleusercontent.com","access_token":"xxxx.xx-xxxxxxxxx","token_type":"Bearer","refresh_token":"x//xxxxxxx-xxxxxxx","expiry":"2020-01-03T06:11:01.3298117Z"} - ```` - -##### Troubleshooting of sign in - -As of Jan. 2, 2020, for the accounts that sign in to skicka for the first time, may have a problem of being displayed as `Sign in with Google temporarily disabled for this app`. -The workaround is to set up the Google Drive API client ID and secret, and set them in skicka. - -[Follow this article (japanese only)](https://qiita.com/satackey/items/34c7fc5bf77bd2f5c633) to set up a client ID and secret. [See translated by Google](https://translate.google.com/translate?&sl=ja&tl=en&u=https%3A%2F%2Fqiita.com%2Fsatackey%2Fitems%2F34c7fc5bf77bd2f5c633) - -Replace `xxxx-your-google-client-id-xx.googleusercontent.com` and `xxx_yourGoogleClientSecret_xxxx`, run the following command. - -```shell -$ docker run -e GOOGLE_CLIENT_ID=xxxx-your-google-client-id-xx.googleusercontent.com -e GOOGLE_CLIENT_SECRET=xxx_yourGoogleClientSecret_xxxx --rm -it --entrypoint "ash" satackey/skicka -``` - -When the container starts, run the following command. -``` -# sed -i -e "s/;clientid=YOUR_GOOGLE_APP_CLIENT_ID/clientid=$GOOGLE_CLIENT_ID/" ~/.skicka.config && sed -i -e "s/;clientsecret=YOUR_GOOGLE_APP_SECRET/clientsecret=$GOOGLE_CLIENT_SECRET/" ~/.skicka.config && skicka -no-browser-auth ls && cat /root/.skicka.tokencache.json -``` - -Return to step 2 and proceed, and similarly **register your client ID and secret to the GitHub secret**. - -## Inputs - -- `skicka-tokencache-json` **Required** - The credentials of the account to upload, generated by `skicka`. (Contents of `~/.skicka.tokencache.json`) - -- `upload-from` optional - Upload source path. Default is the current directory. - -- `upload-to` **Required** for upload - Upload destination path. - -- `download-from` **Required** for download - Download source path. - -- `download-to` optional - Download destination path. Default is the current directory. - -- `google-client-id` optional - OAuth2.0 client ID of Google APIs when using skicka. - **Required** for those who set up Google Drive API client ID and secret themselves. - (Same for `google-client-secret` below) - -- `google-client-secret` optional - OAuth2.0 Client Secret of Google APIs when using skicka. - -- `remove-outdated` optional, default: `'true'` - Whether to delete files that are not local but exist on Google Drive, either `'true'` or `'false'` - > **Note**: It is recommended to turn it off when performing operations involving large files, because it detects files that do not exist locally and downloads them. - -## Contribution -PRs are accepted. Contributions to the [roadmap](#roadmap) are also welcome! - -If you are having trouble or feature request, [post new issue](https://github.com/satackey/action-google-drive/issues/new). - -### Roadmap -- Support Windows / macOS runner ([#9](https://github.com/satackey/action-google-drive/issues/6)) -- Embedded skicka metadata caching diff --git a/action.yml b/action.yml index 5ba7fab..9389d96 100644 --- a/action.yml +++ b/action.yml @@ -1,56 +1,46 @@ name: Interact with Google Drive description: Upload/Download files to/from Google Drive - branding: icon: upload-cloud - color: 'gray-dark' - + color: gray-dark inputs: skicka-tokencache-json: - description: 'Content of `~/.skicka.tokencache.json` created by the `skicka` command' + description: Content of `~/.skicka.tokencache.json` created by the `skicka` command required: true - upload-from: - description: 'The path where the files to upload are located' - default: './' + description: The path where the files to upload are located + default: ./ required: false - upload-to: - description: 'The path where the files to be uploaded is located' + description: The path where the files to be uploaded is located required: false - download-from: description: The path where the files to download are located required: false - download-to: description: The path where the files to be downloaded is located required: false default: ./ - remove-outdated: - description: 'Whether to delete files that do not exist locally' + description: Whether to delete files that do not exist locally default: 'true' required: false - google-client-id: description: Your Google Drive API client ID required: false - google-client-secret: description: Your Google Drive API client secret required: false - - runs: using: docker - image: Dockerfile + image: >- + docker://docker.io/satackey/action-google-drive:b4dd1fa3f60fa1794dd7c0513a400e38b9faa675 env: - SKICKA_TOKENCACHE_JSON: ${{ inputs.skicka-tokencache-json }} - UPLOAD_FROM: ${{ inputs.upload-from }} - UPLOAD_TO: ${{ inputs.upload-to }} - DOWNLOAD_FROM: ${{ inputs.download-from }} - DOWNLOAD_TO: ${{ inputs.download-to }} - REMOVE_OUTDATED: ${{ inputs.remove-outdated }} - GOOGLE_CLIENT_ID: ${{ inputs.google-client-id }} - GOOGLE_CLIENT_SECRET: ${{ inputs.google-client-secret }} + SKICKA_TOKENCACHE_JSON: '${{ inputs.skicka-tokencache-json }}' + UPLOAD_FROM: '${{ inputs.upload-from }}' + UPLOAD_TO: '${{ inputs.upload-to }}' + DOWNLOAD_FROM: '${{ inputs.download-from }}' + DOWNLOAD_TO: '${{ inputs.download-to }}' + REMOVE_OUTDATED: '${{ inputs.remove-outdated }}' + GOOGLE_CLIENT_ID: '${{ inputs.google-client-id }}' + GOOGLE_CLIENT_SECRET: '${{ inputs.google-client-secret }}' diff --git a/entrypoint.sh b/entrypoint.sh deleted file mode 100755 index 6c9fe17..0000000 --- a/entrypoint.sh +++ /dev/null @@ -1,39 +0,0 @@ -#!/bin/sh - -set -eu - -if [ ! -e ~/.skicka.config ]; then - skicka init -fi - -echo $SKICKA_TOKENCACHE_JSON > $HOME/.skicka.tokencache.json - -if [ -n "$GOOGLE_CLIENT_ID" ]; then - sed -i -e "s/;clientid=YOUR_GOOGLE_APP_CLIENT_ID/clientid=$GOOGLE_CLIENT_ID/" ~/.skicka.config - sed -i -e "s/;clientsecret=YOUR_GOOGLE_APP_SECRET/clientsecret=$GOOGLE_CLIENT_SECRET/" ~/.skicka.config -fi - -if [ -n "$DOWNLOAD_FROM" ]; then - echo 'Input download-from has been specified. This action will run the download.' - skicka -no-browser-auth download -ignore-times "$DOWNLOAD_FROM" "$DOWNLOAD_TO" -elif [ -n "$UPLOAD_TO" ]; then - echo 'Input upload-to has been specified. This action will run the upload.' - skicka -no-browser-auth upload -ignore-times "$UPLOAD_FROM" "$UPLOAD_TO" - - # Remove outdated - if [ $REMOVE_OUTDATED == "true" ]; then - # This command will download files that don't exist locally, - # and remove files from downloaded files list. - skicka -verbose download -ignore-times "$UPLOAD_TO" "$UPLOAD_FROM" 2>&1 | \ - sed "/Downloaded and wrote/!d" | \ - sed -E "s/.*bytes to //" | \ - xargs -I{} skicka rm "$UPLOAD_FROM{}" || true - elif [ $REMOVE_OUTDATED != "false" ]; then - echo '$REMOVE_OUTDATED must be "true" or "false".' - exit 1 - fi -else - echo 'Neither input download-from nor upload-to has been specified.' - echo 'You need to specify which one.' - exit 1 -fi