Skip to content

add spell check to markdown files #239

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

Merged
merged 4 commits into from
Feb 7, 2020
Merged

add spell check to markdown files #239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
661dae9
add spell check to markdown files
juancarlostong Feb 6, 2020
5067398
need node version
juancarlostong Feb 6, 2020
8e1ded4
less verbose logs for wget
juancarlostong Feb 6, 2020
ddbd143
spellcheck fixes
juancarlostong Feb 6, 2020
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
12 changes: 12 additions & 0 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,18 @@ jobs:
- find . -type f -name '*.md' -exec awesome_bot {} \;
notifications:
email: false
- stage: 'Lint markdown files'
language: node_js
node_js: 12
os: linux
before_install: skip
install:
- npm i -g markdown-spellcheck
before_script:
- wget --quiet https://gist.githubusercontent.com/juancarlostong/dad02feeebc8763af35b4fdc717cf7a2/raw/29e085302a9418edbefba15d8f790fa76e0a89d5/.spelling
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

opting for a simple wget rather than the more expensive cloning of an entire repo. we only need this one file anyway and there's no secrets in it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it have to be node? Is there a more performant platform we can use?

Also, I'd prefer if we can run this in parallel to the other stages so we don't have to wait for it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it runs in parallel within the 'Lint markdown files' stage. in practice:
Screen Shot 2020-02-07 at 10 36 26 AM

here you can see it finishes in 39 seconds, which is faster than the other job that ran in parallel (43s) meaning that it does not add to the existing build time

script:
- mdspell -a -n -r --en-us '**/*.md'
after_success: skip

- &integrationtest
stage: 'Integration tests'
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ January 23rd, 2020
- Call `get_optimizely_config` to get a snapshot copy of project configuration static data.
- It returns an `OptimizelyConfig` instance which includes a datafile revision number, all experiments, and feature flags mapped by their key values.
- Added caching for `get_optimizely_config` - `OptimizelyConfig` object will be cached and reused for the lifetime of the datafile
- For details, refer to a documention page: https://docs.developers.optimizely.com/full-stack/docs/optimizelyconfig-ruby
- For details, refer to a documentation page: https://docs.developers.optimizely.com/full-stack/docs/optimizelyconfig-ruby


## 3.3.2
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ You can initialize the Optimizely instance in two ways: directly with a datafile

#### Initialization by OptimizelyFactory

1. Initialize Optimizely by providing an `sdk_key` and an optional `datafile`. This will initialize an HTTPConfigManager that makes an HTTP GET request to the URL (formed using your provided `sdk_key` and the default datafile CDN url template) to asynchronously download the project datafile at regular intervals and update ProjectConfig when a new datafile is recieved.
1. Initialize Optimizely by providing an `sdk_key` and an optional `datafile`. This will initialize an HTTPConfigManager that makes an HTTP GET request to the URL (formed using your provided `sdk_key` and the default datafile CDN url template) to asynchronously download the project datafile at regular intervals and update ProjectConfig when a new datafile is received.

```
optimizely_instance = Optimizely::OptimizelyFactory.default_instance('put_your_sdk_key_here', datafile)
Expand Down