docs(field-level-encryption): add some notes about the crypt_shared library #3011
This file contains hidden or 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
| name: Documentation | |
| on: | |
| pull_request: | |
| paths: | |
| - '.github/workflows/documentation.yml' | |
| - 'package.json' | |
| - 'docs/**' | |
| - 'lib' | |
| - 'test' | |
| - 'website.js' | |
| - 'CHANGELOG.md' | |
| push: | |
| branches: | |
| - master | |
| paths: | |
| - '.github/workflows/documentation.yml' | |
| - 'package.json' | |
| - 'docs/**' | |
| - 'lib' | |
| - 'test' | |
| - 'website.js' | |
| - 'CHANGELOG.md' | |
| permissions: | |
| contents: read | |
| jobs: | |
| lint-documentation: | |
| runs-on: ubuntu-latest | |
| name: Lint Markdown files | |
| steps: | |
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| - name: Setup node | |
| uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0 | |
| with: | |
| node-version: 22 | |
| - run: npm install | |
| - name: Lint MD-Files # run markdownlint | |
| run: npm run lint-md | |
| # enable when "eslint-markdown" can be used without errors | |
| # - name: Lint JS-Files # run eslint to lint the code-blocks themself | |
| # run: npm run lint-js | |
| test-documentation: | |
| runs-on: ubuntu-22.04 | |
| name: Test Generating Docs | |
| steps: | |
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| - run: git fetch --depth=1 --tags # download all tags for documentation | |
| - name: Setup node | |
| uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0 | |
| with: | |
| node-version: 22 | |
| - run: npm install | |
| - name: Setup MongoDB | |
| run: | | |
| wget -q https://downloads.mongodb.org/linux/mongodb-linux-x86_64-ubuntu2204-6.0.20.tgz | |
| tar xf mongodb-linux-x86_64-ubuntu2204-6.0.20.tgz | |
| mkdir -p ./data/db/27017 ./data/db/27000 | |
| printf "\n--timeout 8000" >> ./test/mocha.opts | |
| ./mongodb-linux-x86_64-ubuntu2204-6.0.20/bin/mongod --setParameter ttlMonitorSleepSecs=1 --fork --dbpath ./data/db/27017 --syslog --port 27017 | |
| sleep 2 | |
| ./mongodb-linux-x86_64-ubuntu2204-6.0.20/bin/mongod --version | |
| echo `pwd`/mongodb-linux-x86_64-ubuntu2204-6.0.20/bin >> $GITHUB_PATH | |
| - name: Setup config | |
| run: | | |
| echo "module.exports = {uri:'mongodb://127.0.0.1:27017/mongoose_test'};" > ./.config.js | |
| - run: npm run docs:clean | |
| - run: npm run docs:generate |