Skip to content

Commit

Permalink
Merge pull request #23 from fsprojects/upgrade-build
Browse files Browse the repository at this point in the history
Upgrade build
  • Loading branch information
samritchie authored May 6, 2020
2 parents 997854a + 3a73539 commit b76d96b
Show file tree
Hide file tree
Showing 27 changed files with 1,016 additions and 1,305 deletions.
18 changes: 18 additions & 0 deletions .config/dotnet-tools.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"version": 1,
"isRoot": true,
"tools": {
"fake-cli": {
"version": "5.19.1",
"commands": [
"fake"
]
},
"paket": {
"version": "5.242.2",
"commands": [
"paket"
]
}
}
}
16 changes: 16 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# To learn more about .editorconfig see https://aka.ms/editorconfigdocs

# All files
[*]
indent_style = space

# Xml files
[*.xml]
indent_size = 2

# fsharp files
[*.{fs, fsx}]
indent_style = space
indent_size = 4
trim_trailing_whitespace = true
insert_final_newline = true
30 changes: 0 additions & 30 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
### Description

> Short and descriptive example bug report title
> A summary of the issue and the environment in which it occurs. If suitable,
> include the steps required to reproduce the bug.
### Reproduction steps

> 1. This is the first step
> 2. This is the second step
> 3. Further steps, etc.
### Reproduction code

> `<url>` - a link to the reduced test case (e.g. a GitHub Gist)
### Other info

> Any other information you want to share that is relevant to the issue being
> reported. This might include the lines of code that you have identified as
> causing the bug, and potential solutions (and your opinions on their
> merits).
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### Description

> Description of the requested feature
### Potential alternatives

> 1. This is the first step
> 2. This is the second step
> 3. Further steps, etc.
### Other info

> Any other information you want to share that is relevant to the feature request
50 changes: 50 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Build

on: [push, pull_request]

jobs:
build:
strategy:
matrix:
os: [ubuntu-latest, windows-latest, macOS-latest]
dotnet: [3.1.201]
runs-on: ${{ matrix.os }}

steps:
- uses: actions/checkout@v1
- name: Setup .NET Core
uses: actions/setup-dotnet@v1
with:
dotnet-version: ${{ matrix.dotnet }}
- name: Restore tools
run: dotnet tool restore
- name: Restore dependencies
run: dotnet restore
- name: Run build
run: dotnet fake build -t Build

test:
strategy:
matrix:
os: [ubuntu-latest]
dotnet: [3.1.201]
runs-on: ${{ matrix.os }}

services:
dynamodb-local:
image: amazon/dynamodb-local
ports:
- 8000:8000

steps:
- uses: actions/checkout@v1
- name: Setup .NET Core
uses: actions/setup-dotnet@v1
with:
dotnet-version: ${{ matrix.dotnet }}
- name: Restore tools
run: dotnet tool restore
- name: Restore dependencies
run: dotnet restore
- name: Run tests
run: dotnet fake build -t Test
31 changes: 31 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Release docs

on:
push:
tags:
- '*'

jobs:
build:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Setup .NET Core
uses: actions/setup-dotnet@v1
with:
dotnet-version: 3.1.201
- name: Restore tools
run: dotnet tool restore
- name: Restore dependencies
run: dotnet restore
- name: Generate docs
run: dotnet fake build -t Docs
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
personal_token: ${{ secrets.PERSONAL_TOKEN }}
publish_dir: ./docs/_public
publish_branch: gh-pages
force_orphan: true
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -215,3 +215,6 @@ temp/*
paket-files/*
xunit.html
/db
.DS_Store
.ionide/
.vscode/
342 changes: 277 additions & 65 deletions .paket/Paket.Restore.targets

Large diffs are not rendered by default.

Binary file removed .paket/paket.bootstrapper.exe
Binary file not shown.
72 changes: 0 additions & 72 deletions .paket/paket.targets

This file was deleted.

8 changes: 0 additions & 8 deletions .travis.yml

This file was deleted.

6 changes: 0 additions & 6 deletions FSharp.AWS.DynamoDB.sln
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,13 @@ VisualStudioVersion = 14.0.25420.1
MinimumVisualStudioVersion = 10.0.40219.1
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".paket", ".paket", "{63297B98-5CED-492C-A5B7-A5B4F73CF142}"
ProjectSection(SolutionItems) = preProject
.paket\paket.bootstrapper.exe = .paket\paket.bootstrapper.exe
paket.dependencies = paket.dependencies
paket.lock = paket.lock
.paket\paket.targets = .paket\paket.targets
EndProjectSection
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "project", "project", "{BF60BC93-E09B-4E5F-9D85-95A519479D54}"
ProjectSection(SolutionItems) = preProject
.travis.yml = .travis.yml
appveyor.yml = appveyor.yml
build.cmd = build.cmd
build.fsx = build.fsx
build.sh = build.sh
License.md = License.md
README.md = README.md
RELEASE_NOTES.md = RELEASE_NOTES.md
Expand Down
31 changes: 14 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# FSharp.AWS.DynamoDB [![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)
# FSharp.AWS.DynamoDB

![](https://github.com/fsprojects/FSharp.AWS.DynamoDB/workflows/Build/badge.svg) [![NuGet Badge](https://buildstats.info/nuget/FSharp.AWS.DynamoDB?includePreReleases=true)](https://www.nuget.org/packages/FSharp.AWS.DynamoDB)

FSharp.AWS.DynamoDB an F# wrapper over the standard Amazon.DynamoDB library which
allows you to represent table items using F# records and perform updates, queries and scans
Expand All @@ -7,9 +9,6 @@ using F# quotation expressions.
The API draws heavily on the corresponding [FSharp.Azure.Storage](https://github.com/fsprojects/FSharp.Azure.Storage)
wrapper for Azure table storage.

## NuGet [![NuGet Badge](https://buildstats.info/nuget/FSharp.AWS.DynamoDB?includePreReleases=true)](https://www.nuget.org/packages/FSharp.AWS.DynamoDB)
`Install-Package FSharp.AWS.DynamoDB`

## Introduction

Table items can be represented using F# records:
Expand Down Expand Up @@ -198,23 +197,21 @@ table.Scan(startedBefore (DateTimeOffset.Now - TimeSpan.FromDays 1.))

### Building & Running Tests

Depending on your platform, you can build and run tests running `build.bat` or `build.cmd`.
To successfully run unit tests, you need to have credentials set to your `default` profile in
your local credentials store. Alternative, you could set the following environment variables:
```bash
export AWS_REGION="eu-central-1" # defaults to eu-central-1
export AWS_CREDENTIAL_STORE_PROFILE=<profile name> # uses "default" if unset
export AWS_ACCESS_KEY_ID=<your access key> # your account's access key
export AWS_SECRET_ACCESS_KEY=<your secret key> # your account's secret key
```
To build using the dotnet SDK:

`dotnet tool restore`
`dotnet build`

Tests are run using dynamodb-local on port 8000. Using the docker image is recommended:

`docker run -p 8000:8000 amazon/dynamodb-local`

### Build Status
then

* Windows/.NET [![Build status](https://ci.appveyor.com/api/projects/status/n72o2uj09lr9o3sa/branch/master?svg=true)](https://ci.appveyor.com/project/nessos/fsharp-aws-dynamodb/branch/master)
* Linux/Mono 4.2 [![Build Status](https://travis-ci.org/fsprojects/FSharp.AWS.DynamoDB.png?branch=master)](https://travis-ci.org/fsprojects/FSharp.AWS.DynamoDB/branches)
`dotnet run -p tests/FSharp.AWS.DynamoDB.Tests/FSharp.AWS.DynamoDB.Tests.fsproj`

## Maintainer(s)

- [@AviAvni](https://github.com/AviAvni)
- [@samritchie](https://github.com/samritchie)

The default maintainer account for projects under "fsprojects" is [@fsprojectsgit](https://github.com/fsprojectsgit) - F# Community Project Incubation Space (repo management)
7 changes: 0 additions & 7 deletions appveyor.yml

This file was deleted.

13 changes: 0 additions & 13 deletions build.cmd

This file was deleted.

Loading

0 comments on commit b76d96b

Please sign in to comment.