Skip to content

Commit

Permalink
lint and format markdown and yaml (firebase#2111)
Browse files Browse the repository at this point in the history
* add formatting and linting for markdown and yaml

* format markdown and yaml files

* fix test expecting a string
  • Loading branch information
bkendall authored Apr 7, 2020
1 parent 2fe8633 commit 4050f46
Show file tree
Hide file tree
Showing 16 changed files with 264 additions and 214 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose. Consult [GitHub Help] for more
information on using pull requests.

[GitHub Help]: https://help.github.com/articles/about-pull-requests/
[github help]: https://help.github.com/articles/about-pull-requests/

## Development setup

Expand Down
10 changes: 6 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: ⚠️ Bug report
about: Create a report to help us improve
title: ''
title: ""
labels: bug
assignees: ''

assignees: ""
---
<!-- DO NOT DELETE

<!-- DO NOT DELETE
validate_template=true
template_path=.github/ISSUE_TEMPLATE/bug_report.md
-->
Expand Down Expand Up @@ -40,9 +40,11 @@ Additional locations to check for solutions or assistance from the community:
<!-- What version of the Firebase CLI (`firebase-tools`) are you using? Note that your issue may already be fixed in the latest versions. The latest version can be found at https://github.com/firebase/firebase-tools/releases -->

<!-- Output of `firebase --version` -->

**firebase-tools:**

<!-- e.g. macOS, Windows, Ubuntu -->

**Platform:**

### [REQUIRED] Test case
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: 💡 Feature request
about: Suggest an idea for this project
title: ''
title: ""
labels: feature request
assignees: ''

assignees: ""
---
<!-- DO NOT DELETE

<!-- DO NOT DELETE
validate_template=false
template_path=.github/ISSUE_TEMPLATE/feature_request.md
-->
Expand Down
5 changes: 2 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,14 @@ Thank you for contributing to the Firebase community! Please fill out the form b
Run the linter and test suite
==============================
Run `npm test` to make sure your changes compile properly and the tests all pass on your local machine. We've hooked up this repo with continuous integration to double check those things for you.
Run `npm test` to make sure your changes compile properly and the tests all pass on your local machine. We've hooked up this repo with continuous integration to double check those things for you.
-->


### Description

<!-- Are you fixing a bug? Implementing a new feature? Make sure we have the context around your change. Link to other relevant issues or pull requests. -->

### Scenarios Tested

<!-- Write a list of all the user journeys and edge cases you've tested. Instructions for manual testing can be found at https://github.com/firebase/firebase-tools/blob/master/.github/CONTRIBUTING.md#development-setup -->
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ used for testing.

## Workflows

* `node-test.yml` - unit tests and integration tests.
- `node-test.yml` - unit tests and integration tests.

## Secrets

The following secrets must be defined on the project:

| Name | Description |
|--------------------------|-------------|
| `FBTOOLS_TARGET_PROJECT` | The project ID that should be used for integration tests |
| `service_account_json_base64` | A base64-encoded service account JSON file with access to the selected project |
| Name | Description |
| ----------------------------- | ------------------------------------------------------------------------------ |
| `FBTOOLS_TARGET_PROJECT` | The project ID that should be used for integration tests |
| `service_account_json_base64` | A base64-encoded service account JSON file with access to the selected project |
15 changes: 7 additions & 8 deletions .github/workflows/node-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -103,18 +103,17 @@ jobs:
run: find . -type f -name "*debug.log" | xargs cat

check-package-lock:

runs-on: ubuntu-latest

strategy:
matrix:
node-version: [12.x]

steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- run: npm install --package-lock-only
- run: "git diff --exit-code -- package-lock.json || (echo 'Error: package-lock.json is changed during npm install! Please make sure to use npm >= 6.9.0 and commit package-lock.json.' && false)"
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- run: npm install --package-lock-only
- run: "git diff --exit-code -- package-lock.json || (echo 'Error: package-lock.json is changed during npm install! Please make sure to use npm >= 6.9.0 and commit package-lock.json.' && false)"
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/templates
/node_modules
/lib/**/*
/CONTRIBUTING.md
Loading

0 comments on commit 4050f46

Please sign in to comment.