-
Notifications
You must be signed in to change notification settings - Fork 83
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Create a task for deployment - Move the allowed-wordlist tidy script
- Loading branch information
1 parent
7c38a32
commit 204367a
Showing
3 changed files
with
34 additions
and
19 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,6 +30,7 @@ Please lint and spellcheck your contributions before creating a pull request. We | |
- Command: `yarn cspell` | ||
- Note that we use American spelling | ||
- If you use vscode with the Code Spell Checker extension, the custom dictionary will be used | ||
- You can tidy the allowed-wordlist with `go-task tidy-words` | ||
|
||
### NVM | ||
|
||
|
@@ -67,7 +68,7 @@ Ensure that you can successfully generate a static site as above. | |
|
||
Then, when you're ready to deploy, run the following: | ||
|
||
`git switch deploy && git merge master` | ||
`go-task deploy` | ||
|
||
This obviously assumes that you have ssh push access to the `help-center-docs` repository and are using `[email protected]:getsolus/help-center-docs.git` (as listed by `git config -l`). | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
version: '3' | ||
|
||
set: [pipefail] | ||
|
||
tasks: | ||
# Ensure people new to go-task and used to 'make help' have an easier time | ||
help: | ||
desc: Show how to list available tasks | ||
cmds: | ||
- | | ||
echo "Use 'go-task -l/--list' to list available tasks." | ||
# Merge "master" into "deploy" branch for GitHub pages deployment | ||
deploy: | ||
desc: Merge the "master" branch into "deploy" to start GitHub Pages build | ||
cmds: | ||
- git switch master | ||
- git pull origin master | ||
- git switch deploy | ||
- git merge master | ||
- git push origin deploy | ||
- git switch master | ||
|
||
# Tidy up the allowed-words list | ||
tidy-words: | ||
desc: Tidy and sort the allowed-words list | ||
env: | ||
TARGET: .cspell-allowed-words.txt | ||
cmds: | ||
- awk -i inplace '{print tolower($0)}' $TARGET | ||
- sort -o $TARGET $TARGET | ||
- awk -i inplace '!seen[$0]++' $TARGET |