Merge pull request #4 from editor-tools/upgrade-to-0.29.0

Upgrade to 0.29.0

Author: shana

.gitignore

@@ -72,10 +72,6 @@ Generated_Code #added for RIA/Silverlight projects
 nunit-*.xml
 *.userprefs
 packaging/
-tools/FAKE.Core
-tools/SourceLink.Fake
-tools/xunit.runner.console
-tools/Octokit.CodeFormatter
 *.ncrunch*
 *.GhostDoc.xml
 
@@ -90,4 +86,19 @@ pingme.txt
 docs/_build
 
 # it's 2015, no need to keep this around when migrating projects
-Backup/
+Backup/
+
+# .NET Core
+*.lock.json
+
+# VSCode
+**/.vscode/*
+!**/.vscode/settings.json
+!**/.vscode/tasks.json
+!**/.vscode/launch.json
+
+# CAKE
+.dotnet/*
+tools/*
+!tools/gitversion_wrapper.sh
+!tools/LINQPad

.travis.yml

@@ -1,14 +1,19 @@
 language: csharp
-mono:
-  - 4.2.3
 
-sudo: false  # use the new container-based Travis infrastructure
-os:
-  - osx
-  - linux
-install:
-  - nuget restore Octokit-Mono.sln 
-script: 
-  - mono tools/nuget/NuGet.exe restore Octokit-Mono.sln
-  - ./build.sh BuildMono 
-  - ./build.sh 
+matrix:
+  include:
+    - os: linux
+      dist: trusty
+      sudo: required
+      dotnet: 1.0.4
+    - os: osx
+      osx_image: xcode8
+      dotnet: 1.0.4
+
+before_script:
+  - if test "$TRAVIS_OS_NAME" == "osx"; then export FrameworkPathOverride=/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/4.5/; else export FrameworkPathOverride=/usr/lib/mono/4.5/; fi
+
+script:
+  - git fetch --unshallow --tags
+  - dotnet --info
+  - ./build.sh --linksources=true

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [[email protected]](mailto:[email protected]). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -24,7 +24,7 @@ easiest way to do this. You can then clone down your fork instead:
 
 `git clone https://github.com/MY-USERNAME-HERE/Octokit.net.git Octokit`
 
-After doing that, run the `.\build` script at the root of the repository
+After doing that, run the `.\build.ps1` or `./build.sh` script at the root of the repository
 to ensure everything builds and the tests pass.
 
 ## How can I get involved?
@@ -56,23 +56,31 @@ potential conflicts that may occur in the future.
 If you make focused commits (instead of one monolithic commit) and have descriptive
 commit messages, this will help speed up the review process.
 
-### Adding New files
+At any time you can build the project with
 
-To ensure new files are available in the various projects, we have a helper script
-to synchronize these changes across all the projects in the solution.
+`.\build.ps1 -Target Build`
+or
+`./build.sh --target=build`
 
-If you need to create new files:
+this will also run code analysis rules.
 
-  - add the file to the main `Octokit` project
-  - build the project (to ensure the `csproj` change is saved)
-  - run this command: `.\build FixProjects`
+### Running builds cross platform
 
-At any time you can build the project with `.\build BuildApp` - this will also
-run FxCop analysis.
+Octokit.net uses a CAKE build script and can be built on multiple platforms.
+
+To install dependencies and run the CAKE build script use the following wrapper scripts and parameter syntax:
+
+- Windows (Powershell)
+
+`.\build.ps1 -Target <target> -Configuration Release -LinkSources [Additional Parameters]`
+
+- Linux/OSX (bash)
+
+`./build.sh --target=<target> --configuration==Release --linksources=true [Additional Parameters]`
 
 ### Running Tests
 
-Octokit.net also has a suite of tests which you can run to ensure existing
+Octokit.net has a suite of tests which you can run to ensure existing
 behaviour is not affected. If you're adding new features, please add some
 tests alongside so the maintainers can sleep at night, knowing their
 safety blanket is nice and green!
@@ -81,13 +89,21 @@ The test suite is arranged into fast and slow tests.
 
 #### Fast Tests
 
-**Unit Tests:** `.\build UnitTests`
+**Unit Tests:**
+
+`.\build.ps1 -Target UnitTests` or `./build.sh --target=UnitTests`
+
+Alternatively, you can run the `Octokit.Tests` assembly in the Visual Studio test runner.
 
 These tests verify specific behaviour while being isolated from the rest of the
 library. If you are not familiar with unit testing, have a look at the existing
 examples - they should be easy to apply to your work.
 
-**Convention Tests:** `.\build ConventionTests`
+**Convention Tests:**
+
+`.\build.ps1 -Target ConventionTests` or `./build.sh --target=ConventionTests`
+
+Alternatively, you can run the `Octokit.Tests.Conventions` assembly in the Visual Studio test runner.
 
 These tests verify conventions and structure across the entire codebase -
 ensuring everything is consistent and predictable. When writing new features,
@@ -108,17 +124,21 @@ variables:
 
 `.\script\configure-integration-tests.ps1`
 
+NOTE: On Linux/OSX the environment variables currently need to be configured manually.
+
 After running this, ensure any existing instances of Visual Studio are restarted
 so they pick up the new environment variables are detected.
 
 With these variables set, you can run the integration tests locally using
-`.\build IntegrationTests` or by running the `Octokit.Tests.Integration`
-assembly in the Visual Studio test runner.
 
-**Note:** as the integration tests rely on using the actual GitHub API, you may
-encounter issues if running the tests too frequently. Please use a test account
-so that you're not impacted in the unlikely scenario of your account being
-flagged as a spammer.
+`.\build.ps1 -Target IntegrationTests` or `./build.sh --target=IntegrationTests`
+
+Alternatively, you can run the `Octokit.Tests.Integration` assembly in the Visual Studio test runner.
+
+**Note:** as the integration tests rely on using the actual GitHub API, you will encounter
+API rate limit/abuse detection issues if running the tests too frequently. Please use a test account
+so that your main account is not impacted in the event that the tests trigger the GitHub abuse
+detection mechanism.
 
 ### Testing Documentation
 

GitVersion.yml

@@ -0,0 +1,11 @@
+branches:
+  master:
+    mode: ContinuousDeployment
+    increment: Minor
+    tag: beta
+  dotnetcore:
+    mode: ContinuousDeployment
+    increment: Minor
+    tag: alpha
+ignore:
+  sha: []

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 GitHub, Inc.
+Copyright (c) 2017 GitHub, Inc.
 
 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