Skip to content
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.

Sign up for GitHub

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

Jump to bottom

update to the README with contributing instructions #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update to the README with contributing instructions #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 26 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,35 @@
# Build Tasks
# VSTS Build Extensions from the League

## PowerShell Build
## Description

Tasks to make linting, testing, and publishing PowerShell modules delightful.
This project exists to add common build and release tasks to support workflows that are encouraged by [the League](http://aka.ms/theleague).

Inputs:
There are language specific tasks, as well as general purpose tasks. These tasks also augment and support pipelines built by the [Yo Team](https://github.com/darquewarrior/generator-team) generator.

* `actionType` / Action - Build Action to Perform
* `syntax` / Validate PowerShell Syntax
* `lint` / Lint with PSScriptAnalyzer
* `unit` / Run Unit Tests with Pester
## Contributing

Example:
### CI

```yaml
queue:
name: Hosted VS2017
This project is being built in VSTS. The build definition is in `.vsts-ci.yml`.

steps:
- task: LoECDA.68377f11-49ef-47cc-8f89-8521c12dc65e.c7f221ba-f39c-47b0-bdf8-aa9ca2a13cdb.PowerShellBuild@0
displayName: Lint
inputs:
actionType: "lint"
### Common

- task: LoECDA.68377f11-49ef-47cc-8f89-8521c12dc65e.c7f221ba-f39c-47b0-bdf8-aa9ca2a13cdb.PowerShellBuild@0
displayName: Unit
inputs:
actionType: "unit"
* Create a Branch (or fork the project and create a branch).

```
### Fixing a bug

* If you are not changing the behavior of a task, you can dig right in and fix the bug (making sure all tests pass).

### Modifying an existing task

* We start with the documentation. Edit the `overview.md` document to add the documentation for the task you want to add, including any inputs it may take.
* Start a pull request with those edits to the `overview.md` and after the documentation looks good to the maintainers, we can start updating the task itself.
* Continue to update the pull request with the changes to the task.
* NEED MORE STEPS HERE

### Creating a new task

* We start with the documentation. Edit the `overview.md` document to add the documentation for the task you want to add, including any inputs it may take.
* Start a pull request with those edits to the `overview.md` and after the documentation looks good to the maintainers, we can start adding the task itself.
* Create a folder for your task. This folder must have a [`task.json` file](https://docs.microsoft.com/en-us/vsts/extend/develop/build-task-schema).
* NEED MORE STEPS HERE