-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into jamesbursa/1686-load-legacy-to-staging
- Loading branch information
Showing
107 changed files
with
1,588 additions
and
214 deletions.
There are no files selected for viewing
40 changes: 40 additions & 0 deletions
40
.github/linters/scripts/check-wiki-pages-linked-to-summary.sh
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,40 @@ | ||
#! /bin/bash | ||
# Usage: ./scripts/check-wiki-pages-linked-to-summary.sh | ||
# Checks that all pages in the documentation/wiki/ sub-directory are linked to SUMMARY.md | ||
|
||
REPO_ROOT="../.." | ||
WIKI_DIR="${REPO_ROOT}/documentation/wiki" | ||
TEMP_DIR="./tmp" | ||
WIKI_FILES="${TEMP_DIR}/wiki-files.txt" | ||
SUMMARY_FILES="${TEMP_DIR}/summary-files.txt" | ||
MISSING_FILES="${TEMP_DIR}/missing-from-summary.txt" | ||
mkdir -p tmp # create tmp directory | ||
|
||
# list all of the markdown files in the wiki directory | ||
find "${WIKI_DIR}" -name "*.md" |\ | ||
# make file paths relative to the root of the wiki directory | ||
sed -E "s|${WIKI_DIR}/(.*)|\1|" |\ | ||
# filter out the SUMMARY.md file | ||
grep -Ev '(SUMMARY.md)' |\ | ||
# sort the files alphabetically and write to a temporary file | ||
sort > $WIKI_FILES | ||
|
||
# list all of the markdown files linked in the SUMMARY.md file | ||
grep -oE '\((.*\.md)\)' "${WIKI_DIR}/SUMMARY.md" |\ | ||
# remove the extra parantheses around the markdown files | ||
sed -E "s|\((.+)\)|\1|" |\ | ||
# sort the files alphabetically and write to a temporary file | ||
sort > $SUMMARY_FILES | ||
|
||
# find files that are in the wiki but not in the summary | ||
comm -2 -3 $WIKI_FILES $SUMMARY_FILES > $MISSING_FILES | ||
|
||
# if there are missing files exit with a non-zero code and print them | ||
if [[ -z "$(cat ${MISSING_FILES})" ]]; then | ||
echo "All files added to summary" | ||
exit 0 | ||
else | ||
echo "The following files need to be added to documentation/wiki/SUMMARY.md:" | ||
cat $MISSING_FILES | ||
exit 1 | ||
fi |
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
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
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
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
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
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,24 @@ | ||
# Checks that all of the markdown files in /documentation/wiki/ | ||
# have been added to documenation/wiki/SUMMARY.md | ||
name: CI - Check wiki links | ||
|
||
on: | ||
pull_request: | ||
paths: | ||
- documentation/wiki/** | ||
- .github/workflows/ci-wiki-links.yml | ||
- .github/linters/scripts/check-wiki-pages-linked-to-summary.sh | ||
|
||
defaults: | ||
run: | ||
working-directory: ./.github/linters # ensures that this job runs from the ./linters sub-directory | ||
|
||
jobs: | ||
check-wiki-links: | ||
name: Check wiki links in SUMMARY.md | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- name: Check all wiki files are linked in SUMMARY.md | ||
run: ./scripts/check-wiki-pages-linked-to-summary.sh |
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
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
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,30 @@ | ||
############################ | ||
# DB Environment Variables # | ||
############################ | ||
|
||
# These are used by the Postgres image to create the admin user | ||
POSTGRES_USER=app | ||
POSTGRES_PASSWORD=secret123 | ||
|
||
# Set DB_HOST to localhost if accessing a non-dockerized database | ||
DB_HOST=grants-analytics-db | ||
DB_NAME=app | ||
DB_USER=app | ||
DB_PASSWORD=secret123 | ||
DB_SSL_MODE=allow | ||
|
||
# When an error occurs with a SQL query, | ||
# whether or not to hide the parameters which | ||
# could contain sensitive information. | ||
HIDE_SQL_PARAMETER_LOGS=TRUE | ||
|
||
################################## | ||
# Metabase Environment Variables # | ||
################################## | ||
|
||
MB_DB_TYPE=postgres | ||
MB_DB_DBNAME=app | ||
MB_DB_PORT=5432 | ||
MB_DB_USER=app | ||
MB_DB_PASS=secret123 | ||
MB_DB_HOST=grants-analytics-db |
Oops, something went wrong.