-
Notifications
You must be signed in to change notification settings - Fork 38
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Initial version #1
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,4 @@ | ||
## Initial version | ||
|
||
- Basic download and setup. | ||
- Support for Linux, macOS, and Windows. |
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,26 @@ | ||
Copyright 2020, the Dart project authors. All rights reserved. | ||
Redistribution and use in source and binary forms, with or without | ||
modification, are permitted provided that the following conditions are | ||
met: | ||
|
||
* Redistributions of source code must retain the above copyright | ||
notice, this list of conditions and the following disclaimer. | ||
* Redistributions in binary form must reproduce the above | ||
copyright notice, this list of conditions and the following | ||
disclaimer in the documentation and/or other materials provided | ||
with the distribution. | ||
* Neither the name of Google Inc. nor the names of its | ||
contributors may be used to endorse or promote products derived | ||
from this software without specific prior written permission. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
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,2 +1,102 @@ | ||
# setup-dart | ||
GitHub Action for install and setup of a Dart SDK | ||
|
||
This [GitHub Action]() installs and sets up of a Dart SDK for use in actions by: | ||
|
||
* Downloading the Dart SDK | ||
* Adding the `dart` command and `pub` cache to path | ||
|
||
# Usage | ||
|
||
## Basic | ||
|
||
Install the latest stable SDK, and run Hello World. | ||
|
||
``` | ||
name: Dart | ||
|
||
on: | ||
push: | ||
branches: [ master ] | ||
pull_request: | ||
branches: [ master ] | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: dart-lang/setup-dart@v1 | ||
|
||
- name: Install dependencies | ||
run: dart pub get | ||
|
||
- name: Hello world | ||
run: dart bin/hello_world.dart | ||
``` | ||
|
||
## Check static analysis, formatting, and tests | ||
|
||
Various static checks: | ||
|
||
1) Check static analysis with the Dart analyzer | ||
2) Check code follows Dart ideomatic formatting | ||
3) Check that unit tests pass | ||
|
||
``` | ||
... | ||
steps: | ||
- uses: actions/checkout@v2 | ||
|
||
- name: Install dependencies | ||
run: dart pub get | ||
|
||
- name: Verify formatting | ||
run: dart format --output=none --set-exit-if-changed . | ||
|
||
- name: Analyze project source | ||
run: dart analyze | ||
|
||
- name: Run tests | ||
run: dart test | ||
`` | ||
|
||
## Matrix testing | ||
|
||
Double matrix across two dimensions: | ||
|
||
- All three major operating systems: Linux, macOS, and Windows. | ||
- Dart release channels: stable, beta, dev. | ||
|
||
``` | ||
name: Dart | ||
|
||
on: | ||
push: | ||
branches: [main] | ||
pull_request: | ||
branches: [main] | ||
|
||
jobs: | ||
test: | ||
runs-on: ${{ matrix.os }} | ||
strategy: | ||
matrix: | ||
os: [ubuntu-latest, macos-latest, windows-latest] | ||
channel: [stable, beta, dev] | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: dart-lang/setup-dart@v1 | ||
with: | ||
channel: ${{ matrix.channel }} | ||
|
||
- name: Install dependencies | ||
run: dart pub get | ||
|
||
- name: Run tests | ||
run: dart test | ||
``` | ||
|
||
# License | ||
|
||
See the [`LICENSE`](LICENSE) file. |
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,12 @@ | ||
name: "Setup Dart SDK" | ||
description: "Setup the Dart SDK, and add it to the PATH" | ||
inputs: | ||
channel: | ||
description: "The release channel to install from ('stable', 'beta', or 'dev')" | ||
required: false | ||
default: "stable" | ||
runs: | ||
using: "composite" | ||
steps: | ||
- run: $GITHUB_ACTION_PATH/setup.sh ${{ inputs.channel }} ${{ runner.os }} | ||
shell: bash |
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,40 @@ | ||
#!/bin/bash | ||
|
||
############################################################################### | ||
# Bash script that downloads and does setup for a Dart SDK. # | ||
# Takes three params; first listed is the default: # | ||
# $1: Dart channel: stable|beta|dev # | ||
# $2: OS: Linux|Windows|macOS # | ||
# $3: ARCH: x64|ia32 # | ||
############################################################################### | ||
|
||
|
||
# Parse args. | ||
CHANNEL="${1:-stable}" | ||
OS="${2:-Linux}" | ||
ARCH="${3:-x64}" | ||
OS=$(echo "$OS" | awk '{print tolower($0)}') | ||
echo "Installing Dart SDK from the ${CHANNEL} channel on ${OS}-${ARCH}" | ||
|
||
# Calculate download Url. Based on: | ||
# https://dart.dev/tools/sdk/archive#download-urls | ||
PREFIX="https://storage.googleapis.com/dart-archive/channels" | ||
URL="${PREFIX}/${CHANNEL}/release/latest/sdk/dartsdk-${OS}-${ARCH}-release.zip" | ||
echo "Downloading ${URL}..." | ||
|
||
# Download installation zip. | ||
curl --connect-timeout 15 --retry 5 "$URL" > "${HOME}/dartsdk.zip" | ||
unzip "${HOME}/dartsdk.zip" -d "${RUNNER_TOOL_CACHE}" > /dev/null | ||
if [ $? -ne 0 ]; then | ||
echo -e "::error::Download failed! Please check passed arguments." | ||
exit 1 | ||
fi | ||
rm "${HOME}/dartsdk.zip" | ||
|
||
# Update paths. | ||
echo "${HOME}/.pub-cache/bin" >> $GITHUB_PATH | ||
echo "${RUNNER_TOOL_CACHE}/dart-sdk/bin" >> $GITHUB_PATH | ||
|
||
# Report success, and print version. | ||
echo -e "Succesfully installed Dart SDK:" | ||
${RUNNER_TOOL_CACHE}/dart-sdk/bin/dart --version |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps we should download this into ${RUNNER_TOOL_CACHE}/dart//
That would enable checking if the version is in the cache later. It would mean we'd have to resolve
latest
to a specific version though.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Opened #2 for that, will take a look at that later