diff --git a/cli/Dockerfile b/Dockerfile similarity index 61% rename from cli/Dockerfile rename to Dockerfile index 6806601b6..17761adf5 100644 --- a/cli/Dockerfile +++ b/Dockerfile @@ -1,6 +1,6 @@ FROM bycedric/ci-expo:2 LABEL com.github.actions.name="Expo CLI" -LABEL com.github.actions.description="Use Expo CLI in your GitHub Actions workflow." +LABEL com.github.actions.description="Use any Expo command in your GitHub Actions workflow." LABEL com.github.actions.icon="terminal" LABEL com.github.actions.color="gray-dark" diff --git a/README.md b/README.md index 2fa5b4156..bbfb80af8 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,42 @@ # Expo CLI for GitHub Actions -> Both GitHub Actions and this library are highly unstable, do not use in production. +> Both GitHub Actions and this library are highly unstable, do not use in production (yet). Publish, build or manage your [Expo](https://expo.io) Project with GitHub Actions! This repository contains a prebuilt base image with GitHub Actions implementations. You can also use [the base image](base) in other Docker-based environments. +## Usage + +By default, you have full access to the actual [Expo CLI](https://docs.expo.io/versions/latest/workflow/expo-cli). +That means that you should be able to use every function from the CLI in your actions. +Below you can see an example workflow to get you started right away! + +> Check out both [login](./login) and [publish](./publish) actions for more info. + +```hcl +workflow "Install, Authenticate, and Publish" { + on = "push" + resolves = ["Publish"] +} + +action "Install" { + uses = "actions/npm@master" + args = "install" +} + +action "Authenticate" { + needs = "Install" + uses = "bycedric/ci-expo/login@master" + secrets = ["EXPO_USERNAME", "EXPO_PASSWORD"] +} + +action "Publish" { + needs = "Authenticate" + uses = "bycedric/ci-expo/publish@master" +} +``` + ## License The MIT License (MIT). Please see [License File](LICENSE.md) for more information. diff --git a/cli/LICENSE.md b/cli/LICENSE.md deleted file mode 100644 index 0dbf4c4e9..000000000 --- a/cli/LICENSE.md +++ /dev/null @@ -1,21 +0,0 @@ -# The MIT License (MIT) - -Copyright (c) 2018 Cedric van Putten - -> Permission is hereby granted, free of charge, to any person obtaining a copy -> of this software and associated documentation files (the "Software"), to deal -> in the Software without restriction, including without limitation the rights -> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -> copies of the Software, and to permit persons to whom the Software is -> furnished to do so, subject to the following conditions: -> -> The above copyright notice and this permission notice shall be included in -> all copies or substantial portions of the Software. -> -> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -> THE SOFTWARE. diff --git a/cli/README.md b/cli/README.md deleted file mode 100644 index 7f8c89574..000000000 --- a/cli/README.md +++ /dev/null @@ -1,16 +0,0 @@ -# Expo CLI for GitHub Actions - -This GitHub Action makes the [Expo CLI](https://docs.expo.io/versions/latest/workflow/expo-cli) available to use within your workflow. -It uses a prebuilt image, fully installed with Expo, for fast performance. - -## License - -The MIT License (MIT). Please see [License File](LICENSE.md) for more information. - -> This image is built on top of awesome open source libraries, see [base image license](../base/README.md#license) for more info. - ---- --- - -

- with :heart: byCedric -