Skip to content

Commit 0aa3a8b

Browse files
committed
Update repo
1 parent 2a0d34a commit 0aa3a8b

File tree

5 files changed

+73
-158
lines changed

5 files changed

+73
-158
lines changed

.github/workflows/main.yml

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Build + Test
2+
3+
on: push
4+
5+
jobs:
6+
publish:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- name: Checkout
10+
uses: actions/checkout@v3
11+
with:
12+
fetch-depth: 0
13+
14+
- run: zip -r Microsoft.zip Microsoft -x "*.DS_Store"
15+
16+
- name: Upload style to release
17+
uses: svenstaro/upload-release-action@v2
18+
if: startsWith(github.ref, 'refs/tags/')
19+
with:
20+
repo_token: ${{ secrets.GITHUB_TOKEN }}
21+
file: Microsoft.zip
22+
23+
cucumber:
24+
runs-on: ubuntu-latest
25+
steps:
26+
- name: Checkout
27+
uses: actions/checkout@v3
28+
with:
29+
fetch-depth: 0
30+
31+
- name: Python
32+
uses: actions/setup-python@v4
33+
with:
34+
python-version: "3.10"
35+
36+
- name: Ruby
37+
uses: ruby/setup-ruby@v1
38+
with:
39+
ruby-version: "3.0"
40+
# runs 'bundle install' and caches installed gems automatically
41+
bundler-cache: true
42+
43+
- name: Install Deps
44+
run: |
45+
wget https://github.com/errata-ai/vale/releases/download/v${VALE_VERSION}/vale_${VALE_VERSION}_Linux_64-bit.tar.gz
46+
mkdir bin && tar -xvzf vale_${VALE_VERSION}_Linux_64-bit.tar.gz -C bin
47+
echo "./bin" >> $GITHUB_PATH
48+
49+
pip install yamllint pyyaml docutils
50+
env:
51+
VALE_VERSION: 2.26.0
52+
53+
- name: Features
54+
run: bundle exec cucumber --format progress
55+
env:
56+
CUCUMBER_PUBLISH_QUIET: true
57+
58+
- name: Integration
59+
run: vale README.md

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99
/test/version_tmp/
1010
/tmp/
1111

12+
*.zip
13+
*.lock
14+
1215
# Used by dotenv library to load environment variables.
1316
# .env
1417

.travis.yml

-26
This file was deleted.

CHANGELOG.md

-116
This file was deleted.

README.md

+11-16
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,24 @@
1+
# Microsoft
2+
13
> **NOTE**: This project is neither maintained nor endorsed by Microsoft.
24
35
This repository contains a [Vale-compatible](https://github.com/errata-ai/vale) implementation of the [*Microsoft Writing Style Guide*](https://docs.microsoft.com/en-us/style-guide/welcome/) ([LICENSE](https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/LICENSE)).
46

5-
The goal is to showcase how to build and maintain a full-featured style guide for Vale, including many examples of using [extension points](https://errata-ai.github.io/vale/styles/#extension-points) and a test suite using [Cucumber](https://cucumber.io/), [`yamllint`](https://github.com/adrienverge/yamllint), and [Travis CI](https://travis-ci.org/).
6-
7-
[![Build Status](https://travis-ci.com/errata-ai/Microsoft.svg?branch=master)](https://travis-ci.com/errata-ai/Microsoft) ![Vale version](https://img.shields.io/badge/vale-%3E%3D%20v1.7.0-blue.svg) ![license](https://img.shields.io/github/license/mashape/apistatus.svg)
8-
97
## Getting Started
108

11-
> :exclamation: Microsoft requires Vale >= **1.7.0**. :exclamation:
12-
13-
Download the [latest release](https://github.com/errata-ai/Microsoft/releases), copy the "Microsoft" directory to your `StylesPath`, and include it in your configuration file:
9+
To get started, add the package to your configuration file (as shown below) and then run `vale sync`.
1410

1511
```ini
16-
# This goes in a file named either `.vale.ini` or `_vale.ini`.
17-
StylesPath = path/to/some/directory
18-
MinAlertLevel = warning # suggestion, warning or error
19-
20-
# Only Markdown and .txt files; change to whatever you're using.
21-
[*.{md,txt}]
22-
# List of styles to load.
23-
BasedOnStyles = Microsoft
12+
StylesPath = styles
13+
MinAlertLevel = suggestion
14+
15+
Packages = Microsoft
16+
17+
[*]
18+
BasedOnStyles = Vale, Microsoft
2419
```
2520

26-
See [Usage](https://github.com/errata-ai/vale/#usage) for more information.
21+
See [Packages](https://vale.sh/hub/microsoft/) for more information.
2722

2823
## Repository Structure
2924

0 commit comments

Comments
 (0)