Asset Update Process

Introduction

We offer our documentation and the build list of SQL Server via the sqlcollaborative/sqlcollaborative.github.io repository. The short links for these two sites:

• dbatools.io/builds (buildref)
• docs.dbatools.io (docs)

buildref

This information is maintained and utilized by Get-DbaBuildReference. This command defaults to use the local version that we ship with each release, however, builds of SQL Server can be released frequently. We added -Update as a switch to pull the latest version we have published. This switch utilizes a configuration value that we set to know where to get the file from; you can see this by using Get-DbatoolsConfigValue -Name 'assets.sqlbuildreference'.

We utilize GitHub Actions for updating the remote repository to keep the dbatools module as the original version of the file. The badge for this is provided below for reference:

docs

The docs file that we maintain is simply an export of the help for the module's commands. We export that to a JSON file, and then one of our contributors fancied up some JavaScript that parses that content into what you see on our docs.dbatools.io site. The file is in the repository referenced earlier.

Schedule

GitHub Action.

The current schedule of this action is to run every day at 4:00 AM UTC.

At that given time, it will only do a pull of the dbatools repository with a depth of 1 on the git command, to keep it lightweight. If the file has changes to be committed, then that will be performed and pushed to the repository.