Runs the management commands required to populate the Boost database from scratch with Boost versions, libraries, and other associated data.
Read more about boost_setup
in Populating the Database for the First Time.
Example
./manage.py boost_setup
Options
Options | Format | Description |
---|---|---|
--token |
string | GitHub API Token. If passed, will use this value. If not passed, will use the value in settings. |
Process: See Populating the Database for the First Time.
Imports Version
objects from GitHub.
Example
./manage.py import_versions
Options
Options | Format | Description |
---|---|---|
--delete-versions |
bool | If passed, will delete all Version objects before importing Versions. |
--new |
bool | If passed, will import only new Version objects. |
--token |
string | GitHub API Token. If passed, will use this value. If not passed, will use the value in settings. |
Process
- Retrieves the tags for the GitHub repo in
BASE_GITHUB_URL
- Loops through all tags, and discards any that do not match our inclusion logic
- For each successful tag, import it as a
Version
object - Then, run the command to the release downloads from Artifactory as
VersionFile
objects
This process is run automatically as part of import_versions
.
Import VersionFile
objects from Artifactory.
Example
./manage.py import_archives_release_data
Options
Options | Format | Description |
---|---|---|
--release |
string | Format: boost-1.63.0 . If passed, will import Archive urls for only that version. |
More Information
- Loops through
Version
objects and calls the task that retrieves the Archives data with the version information - Saves the Archives JSON data as
VersionFile
objects
This process was run automatically as part of import_versions
, but has been replaced by import_archives_release_data
.
Import VersionFile
objects from Artifactory.
Example
./manage.py import_artifactory_release_data
Options
Options | Format | Description |
---|---|---|
--release |
string | Format: boost-1.63.0 . If passed, will import Artifactory urls for only that version. |
More Information
- Loops through
Version
objects and calls the task that retrieves the Artifactory data with the version information - Saves the Artifactory data as
VersionFile
objects
Purpose: Import and update Library
and Category
objects. Runs the library update script, which cycles through the repos listed in the Boost library and syncs their information. Most library information comes from meta/libraries.json
stored in each Boost library repo.
Example
./manage.py update_libraries
Options
Options | Format | Description |
---|---|---|
--token |
string | GitHub API Token. If passed, will use this value. If not passed, will use the value in settings. |
Purpose: Import and update LibraryVersion
objects.
Example
./manage.py import_library_versions
Options
Options | Format | Description |
---|---|---|
--token |
string | GitHub API Token. If passed, will use this value. If not passed, will use the value in settings. |
--release |
string | Format: boost-1.63.0 . If passed, will import Artifactory urls for only that version. Partial versions are accepted (so "1.7" will import libraries for version 1.70.0, 1.71.0, etc.) |
Process
- Loops through
Version
objects based on passed-in options - For each
Version
, gets the libraries in that release from the.gitmodules
file using the GitHub API - For each library listed in the
.gitmodules
file, get the complete list of libraries from the library'smeta/libraries.json
file (in its GitHub repo) using the GitHub API. (A single library repo might contain information for multiple libraries. Example: Functional also hosts Functional/Factory). - Save the
LibraryVersion
objects - Call the task to import documentation urls from data hosted in the S3 bucket
This process is taken care of automatically as part of import_library_versions
.
Purpose: Because of uniqueness in Boost library data, it's not possible to consistently format the URL for each Boost library-version. The current process involves hitting the url for the page in the Boost release notes that lists all the libraries and manually copying the URLs from the <ul>
on that page to each LibraryVersion
object.
Example
./manage.py get_library_version_documentation_urls --version=1.81.0
Options
Options | Format | Description |
---|---|---|
--min-version |
string | Specify the minimum version for which you want to retrieve documentation URLs. The default is defined in the settings file. |
--version |
string | Format: 1.81.0 . Specify the version for which you want to retrieve documentation URLs. You can provide a specific version number (example: 1.81.0 ) or a partial version number to process all versions that contain the partial version number (example: 1.7 would process 1.70.0, 1.71.0, 1.72.0, etc.). If no version is specified, all active versions will be processed. |
Process
- This command cycles through all Versions in the database, or specified versions using the
--version
option. - For each version, the command calls a celery task that retrieves and stores the library version documentation url paths from S3.
- If a library version's documentation URL cannot be found, the command will skip and continue with the next library version.
Cycles through all library-versions and uses the maintainers
element in the data
JSONField to load the maintainer information from GitHub into the database.
Example
./manage.py update_maintainers
Options
Options | Format | Description |
---|---|---|
--library-name |
string | Name of the library. If passed, the command will load maintainers for only this library. |
--release |
string | Format: boost-1.63.0 . If passed, will import Artifactory urls for only that version. |
If both the --release
and the --library-name
are passed, the command will load maintainers for only that Library-Version.
Purpose: Cycles through all libraries and uses the authors
element in the data
JSONField to load the author information from GitHub into the database.
Example
./manage.py update_authors
Options
Options | Format | Description |
---|---|---|
--library-name |
string | Name of the library. If passed, the command will load maintainers for only this library. |
Purpose: Saves CommitData
objects. Each object contains the data for the number of commits made to the master
branch of a given Library
with in a given month.
Example
./manage.py import_commit_counts
Options
Options | Format | Description |
---|---|---|
--branch |
string | Specify the branch you want to count commits for. Defaults to master . |
--token |
string | Pass a GitHub API token. If not passed, will use the value in settings.GITHUB_TOKEN . |
Purpose: Imports the most recent beta release
Example
./manage.py import_beta_release
Options
Options | Format | Description |
---|---|---|
--token |
string | Pass a GitHub API token. If not passed, will use the value in settings.GITHUB_TOKEN . |
--delete-versions |
bool | If passed, all existing beta Version records will be deleted before the new beta release is imported. |