Skip to content

Commit

Permalink
docs: README with install notes
Browse files Browse the repository at this point in the history
  • Loading branch information
pwtyler committed Apr 4, 2023
1 parent 1bcb88f commit 20a3835
Showing 1 changed file with 31 additions and 10 deletions.
41 changes: 31 additions & 10 deletions README.MD
Original file line number Diff line number Diff line change
@@ -1,28 +1,49 @@
# Sites.yml | Pantheon.yml Validator
# Pantheon YML Validator

A utility for validating a sites.yml file on a pantheon site during WordPress multisites' search-replace tasks. Asprirationally to include pantheon.yml validation in the future.
A utility for validating a sites.yml file on a Pantheon site during WordPress multisites' search-replace tasks. Asprirationally to include pantheon.yml validation in the future.

# Usage
## Usage

## Sites.yml
### Sites.yml
```
$ pyml-validator sites -f path/to/sites.yml
```

See [this annotated fixture](./fixtures/sites/valid.yml) for an example of a valid sites.yml file.

## Pantheon.yml
Note, validation of pantheon.yml is unimplemented, so any file reads as valid.
## Install

### [Download the latest binary](https://github.com/pantheon-systems/pyml-validator/releases/latest)

Use wget to download, gzipped pre-compiled binaries:
For instance, VERSION=v0.0.11 and BINARY=pyml-validator_linux_amd64

### Compressed via tar.gz
```bash
wget https://github.com/pantheon-systems/pyml-validator/releases/download/${VERSION}/${BINARY}.tar.gz -O - |\
tar xz && mv ${BINARY} /usr/bin/pyml-validator
```

### Plain binary

```bash
wget https://github.com/pantheon-systems/pyml-validator/releases/download/${VERSION}/${BINARY} -O /usr/bin/pyml-validator &&\
chmod +x /usr/bin/pyml-validator
```
$ pyml-validator pantheon -f path/to/pantheon.yml

### Latest version

```bash
wget https://github.com/pantheon-systems/pyml-validator/releases/latest/download/pyml-validator_linux_amd64 -O /usr/bin/pyml-validator &&\
chmod +x /usr/bin/pyml-validator
```

# Testing
## Testing

[![Coverage Status](https://coveralls.io/repos/github/pantheon-systems/pyml-validator/badge.svg?t=PGhafd)](https://coveralls.io/github/pantheon-systems/pyml-validator)

`make test` runs linting and testing.

# Releases
## Releases

Automatically releases on merge to main via autotag + goreleaser. See [Autotag Readme](https://github.com/pantheon-systems/autotag) for details on how the SemVer is determined. Note, with goreleaser, each commit merged will become a line item in the release's Changelog. Take note to use squashing and/or rebase to ensure helpful and informative commit messages.
Automatically releases on merge to main via autotag + goreleaser. See [Autotag Readme](https://github.com/pantheon-systems/autotag) for details on how the SemVer is determined. With goreleaser, each commit merged will become a line item in the release's Changelog. Take note to use squashing and/or rebase to ensure helpful and informative commit messages.

0 comments on commit 20a3835

Please sign in to comment.