Please use https://github.ibm.com/cloud-docs/Cloudant for contributions. Pushes to https://github.com/ibm-cloud-docs/Cloudant are only allowed by members of documentation team.
Jenkins is used to publish docs to staging and to production. The setup is managed by IBM Cloud Documentation team.
https://wcp-ace-docs-jenkins.swg-devops.com/job/Docs-build/job/Docs-build-Cloudant/
Travis is used to keep github.com and github.ibm.com repositories in sync. The setup is managed by Cloudant infra team.
https://travis.ibm.com/Bluemix-Docs
Please use https://github.ibm.com/cloud-docs/Cloudant for contributions to the documentation. Pushes to https://github.com/ibm-cloud-docs/Cloudant are only allowed by members of the documentation team. See Documentation Update Process for instructions.
If you are not an IBM employee and want to make a documentation contribution, go to the IBM Cloudant documentation and click Feedback
on the page where you want to comment.
This repository uses detect-secrets
to prevent committing sensitive information like API keys, tokens, and passwords.
Secrets are tracked using a .secrets.baseline
file. This file contains a hash of detected secret patterns and is version-controlled.
On every pull request, GitHub Actions will:
- Scan the codebase using the committed baseline.
- Fail the build if new untracked secrets are found.
If your PR is failing due to newly detected secrets (false positives or intentional additions), follow the steps below to update the baseline:
Use the provided Makefile
to automatically install and run detect-secrets
, then clean up:
make update-secrets