generated from actions/javascript-action
-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from emmanuelgautier/init-github-action
feat: init cloudinary upload github action
- Loading branch information
Showing
22 changed files
with
72,491 additions
and
977 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| CLOUDINARY_CLOUD_NAME= | ||
| CLOUDINARY_API_KEY= | ||
| CLOUDINARY_API_SECRET= |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,65 @@ | ||
| name: "units-test" | ||
| name: "tests" | ||
| on: | ||
| pull_request: | ||
| push: | ||
| branches: | ||
| - main | ||
| - 'releases/*' | ||
| - "releases/*" | ||
|
|
||
| jobs: | ||
| # unit tests | ||
| units: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - run: npm ci | ||
| - run: npm test | ||
| - uses: actions/checkout@v2 | ||
| - run: npm ci | ||
| - env: | ||
| CLOUDINARY_CLOUD_NAME: ${{ secrets.CLOUDINARY_CLOUD_NAME }} | ||
| CLOUDINARY_API_KEY: ${{ secrets.CLOUDINARY_API_KEY }} | ||
| CLOUDINARY_API_SECRET: ${{ secrets.CLOUDINARY_API_SECRET }} | ||
| run: npm test | ||
|
|
||
| # test action works running from the graph | ||
| test: | ||
| test-one-image: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - uses: ./ | ||
| with: | ||
| milliseconds: 1000 | ||
| - uses: actions/checkout@v2 | ||
| - uses: ./ | ||
| with: | ||
| cloud-name: ${{ secrets.CLOUDINARY_CLOUD_NAME }} | ||
| api-key: ${{ secrets.CLOUDINARY_API_KEY }} | ||
| api-secret: ${{ secrets.CLOUDINARY_API_SECRET }} | ||
| image: "./medias/images/test1.jpg" | ||
|
|
||
| test-upload-one-image-without-public-id: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - uses: ./ | ||
| with: | ||
| cloud-name: ${{ secrets.CLOUDINARY_CLOUD_NAME }} | ||
| api-key: ${{ secrets.CLOUDINARY_API_KEY }} | ||
| api-secret: ${{ secrets.CLOUDINARY_API_SECRET }} | ||
| image: "./medias/images/test1.jpg" | ||
|
|
||
| test-bulk-upload-images-pattern: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - uses: ./ | ||
| with: | ||
| cloud-name: ${{ secrets.CLOUDINARY_CLOUD_NAME }} | ||
| api-key: ${{ secrets.CLOUDINARY_API_KEY }} | ||
| api-secret: ${{ secrets.CLOUDINARY_API_SECRET }} | ||
| images: "./medias/**/*.jpg" | ||
|
|
||
| test-bulk-upload-images-array: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - uses: ./ | ||
| with: | ||
| cloud-name: ${{ secrets.CLOUDINARY_CLOUD_NAME }} | ||
| api-key: ${{ secrets.CLOUDINARY_API_KEY }} | ||
| api-secret: ${{ secrets.CLOUDINARY_API_SECRET }} | ||
| images: "[\"./medias/images/test1.jpg\", \"./medias/images/test2.jpg\"]" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| lts/erbium |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,116 +1,70 @@ | ||
| # Create a JavaScript Action | ||
| ## "Cloudinary Upload" Action For GitHub Actions | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/actions/javascript-action/actions"><img alt="javscript-action status" src="https://github.com/actions/javascript-action/workflows/units-test/badge.svg"></a> | ||
| </p> | ||
| Upload your medias with Cloudinary Upload Github Action to [Cloudinary](https://cloudinary.com/) SaaS solution for images and videos upload, storage, optimization and CDN. | ||
|
|
||
| Use this template to bootstrap the creation of a JavaScript action.:rocket: | ||
| **Table of Contents** | ||
|
|
||
| This template includes tests, linting, a validation workflow, publishing, and versioning guidance. | ||
| <!-- toc --> | ||
|
|
||
| If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action) | ||
| - [Usage](#usage) | ||
| - [Credentials](#credentials) | ||
| - [Maintainers](#maintainers) | ||
| - [License](#license) | ||
|
|
||
| ## Create an action from this template | ||
| <!-- tocstop --> | ||
|
|
||
| Click the `Use this Template` and provide the new repo details for your action | ||
|
|
||
| ## Code in Main | ||
|
|
||
| Install the dependencies | ||
|
|
||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| Run the tests :heavy_check_mark: | ||
|
|
||
| ```bash | ||
| $ npm test | ||
|
|
||
| PASS ./index.test.js | ||
| ✓ throws invalid number (3ms) | ||
| ✓ wait 500 ms (504ms) | ||
| ✓ test runs (95ms) | ||
| ... | ||
| ``` | ||
|
|
||
| ## Change action.yml | ||
|
|
||
| The action.yml defines the inputs and output for your action. | ||
|
|
||
| Update the action.yml with your name, description, inputs and outputs for your action. | ||
|
|
||
| See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions) | ||
|
|
||
| ## Change the Code | ||
|
|
||
| Most toolkit and CI/CD operations involve async operations so the action is run in an async function. | ||
|
|
||
| ```javascript | ||
| const core = require('@actions/core'); | ||
| ... | ||
| ## Usage | ||
|
|
||
| async function run() { | ||
| try { | ||
| ... | ||
| } | ||
| catch (error) { | ||
| core.setFailed(error.message); | ||
| } | ||
| } | ||
| Add the following step to your workflow: | ||
|
|
||
| run() | ||
| ```yaml | ||
| - name: Cloudinary Upload Image | ||
| uses: aws-actions/configure-aws-credentials@v1 | ||
| with: | ||
| cloud-name: ${{ secrets.CLOUDINARY_CLOUD_NAME }} | ||
| api-key: ${{ secrets.CLOUDINARY_API_KEY }} | ||
| api-secret: ${{ secrets.CLOUDINARY_API_SECRET }} | ||
| image: "./your-image.jpg" | ||
| ``` | ||
| See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages. | ||
|
|
||
| ## Package for distribution | ||
|
|
||
| GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules. | ||
|
|
||
| Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder. | ||
| ### Multiple files upload | ||
| Run prepare | ||
| You can upload multiple files with the `images` parameter putting a file path pattern. | ||
|
|
||
| ```bash | ||
| npm run prepare | ||
| ``` | ||
|
|
||
| Since the packaged index.js is run from the dist folder. | ||
|
|
||
| ```bash | ||
| git add dist | ||
| ```yaml | ||
| - name: Cloudinary Upload Images | ||
| uses: aws-actions/configure-aws-credentials@v1 | ||
| with: | ||
| cloud-name: ${{ secrets.CLOUDINARY_CLOUD_NAME }} | ||
| api-key: ${{ secrets.CLOUDINARY_API_KEY }} | ||
| api-secret: ${{ secrets.CLOUDINARY_API_SECRET }} | ||
| images: "./medias/**/*.jpg" | ||
| ``` | ||
|
|
||
| ## Create a release branch | ||
| Or directly an array of files path. | ||
|
|
||
| Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions. | ||
|
|
||
| Checkin to the v1 release branch | ||
|
|
||
| ```bash | ||
| git checkout -b v1 | ||
| git commit -a -m "v1 release" | ||
| ``` | ||
|
|
||
| ```bash | ||
| git push origin v1 | ||
| ```yaml | ||
| - name: Cloudinary Upload Images | ||
| uses: aws-actions/configure-aws-credentials@v1 | ||
| with: | ||
| cloud-name: ${{ secrets.CLOUDINARY_CLOUD_NAME }} | ||
| api-key: ${{ secrets.CLOUDINARY_API_KEY }} | ||
| api-secret: ${{ secrets.CLOUDINARY_API_SECRET }} | ||
| images: "[\"./medias/images/test1.jpg\", \"./medias/images/test2.jpg\"]" | ||
| ``` | ||
|
|
||
| Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project. | ||
| See [action.yml](action.yml) for the full documentation for this action's inputs and outputs. | ||
|
|
||
| Your action is now published! :rocket: | ||
| ## Credentials | ||
|
|
||
| See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) | ||
| We recommend following [Configuration Cloudinary Documentation](https://cloudinary.com/documentation/node_integration#configuration) for adding your credentials. | ||
|
|
||
| ## Usage | ||
| ## Maintainers | ||
|
|
||
| You can now consume the action by referencing the v1 branch | ||
| [](https://www.emmanuelgautier.com) | | ||
| --- | | ||
| [Emmanuel Gautier](https://www.emmanuelgautier.com) | | ||
|
|
||
| ```yaml | ||
| uses: actions/javascript-action@v1 | ||
| with: | ||
| milliseconds: 1000 | ||
| ``` | ||
| ## License | ||
|
|
||
| See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket: | ||
| MIT © [Emmanuel Gautier](https://www.emmanuelgautier.com) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.