grafana/scripts/ci-reference-docs-build.sh

#!/bin/bash

# abort if we get any error
set -eo pipefail

BUILD_MODE="${1-local}"

if [ "local" == "$BUILD_MODE" ]
  then
    # building grafana packages
    echo "building grafana packages..."
    yarn packages:build
  else
    echo "skip building grafana packages since it already built in previous steps..."
fi

# extract packages api documentation json
echo "extracting packages documentation data..."
yarn packages:docsExtract

# generating api documentation markdown
echo "generating markdown from documentation data..."
yarn packages:docsToMarkdown
Build: scripts to build and measure packages reference docs (#24876) * added script to check docs metrics. * added information link on how to add code comments. * added script for build and measure code comment metrics. * fixed issues according to shellcheck. * Added so we build the metrics if report folder is missing. * added some spacing and a devider. * Added so we can send metrics to grafana. * added shellcheck attribute. * Fixed spelling according to feedback. * see if shellcheck passes. * fixed issue with shellcheck. * Explore/Logs: Fix tooltip display for log graph (#25544) Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com> Co-authored-by: kay delaney <45561153+kaydelaney@users.noreply.github.com> 2020-06-16 02:33:23 -05:00			`#!/bin/bash`
Docs: adding API reference documentation support for the packages libraries. (#21931) * trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added parameters and return values. * Fixed merge error. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * lerna bootstrap. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. 2020-02-25 06:59:11 -06:00
			`# abort if we get any error`
Build: scripts to build and measure packages reference docs (#24876) * added script to check docs metrics. * added information link on how to add code comments. * added script for build and measure code comment metrics. * fixed issues according to shellcheck. * Added so we build the metrics if report folder is missing. * added some spacing and a devider. * Added so we can send metrics to grafana. * added shellcheck attribute. * Fixed spelling according to feedback. * see if shellcheck passes. * fixed issue with shellcheck. * Explore/Logs: Fix tooltip display for log graph (#25544) Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com> Co-authored-by: kay delaney <45561153+kaydelaney@users.noreply.github.com> 2020-06-16 02:33:23 -05:00			`set -eo pipefail`
Docs: adding API reference documentation support for the packages libraries. (#21931) * trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added parameters and return values. * Fixed merge error. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * lerna bootstrap. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. 2020-02-25 06:59:11 -06:00
Build: added steps to generate packages api documentation. (#27930) * added steps to generate docs. * re-generated the drone.yml file. * removed metrics reporting from pr pipeline. * fixed spelling issues. * fixed so package generation should work. * some small refactorings. * fixed spelling error. * adding echo to verify that we execute the correct script. * removed echo statement. * changed scripts a bit. * added ci flag to script. * adding exit 1 * increased the limit. * added missing space. * fixed shellcheck error. * fixing lint errors. * renamed build step. * changed logic. * increased limit. * changed to echo instead of echo -e * fixed shellcheck errors. * trying to debug script, * trying to simplify the find statement. * fixed issue with text formatting on linux. * imported build step. * Update scripts/ci-reference-docs-lint.sh Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com> * removed cleanup of packages. * increased limit. * will build frontend docs on master but not lint it. * will always run the linting step. Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com> 2020-10-14 07:35:55 -05:00			`BUILD_MODE="${1-local}"`

			`if [ "local" == "$BUILD_MODE" ]`
			`then`
			`# building grafana packages`
			`echo "building grafana packages..."`
			`yarn packages:build`
			`else`
			`echo "skip building grafana packages since it already built in previous steps..."`
			`fi`
Docs: adding API reference documentation support for the packages libraries. (#21931) * trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added parameters and return values. * Fixed merge error. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * lerna bootstrap. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. 2020-02-25 06:59:11 -06:00
			`# extract packages api documentation json`
			`echo "extracting packages documentation data..."`
			`yarn packages:docsExtract`

			`# generating api documentation markdown`
			`echo "generating markdown from documentation data..."`
			`yarn packages:docsToMarkdown`