boost/website-v2
2
0
Fork 0
mirror of https://github.com/boostorg/website-v2.git synced 2026-01-19 04:42:17 +00:00
Code Issues Projects Releases Wiki Activity

Updated import commands to allow and default to 'new' functionality. Remove artifactory-related commands. (#1744)

Browse Source
This commit is contained in:
Dave O'Connor
2025-08-18 11:47:06 -07:00
committed by Kari Skinner
parent a61c8d769d
commit c6335c2fe2
12 changed files with 125 additions and 134 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
docs/commands.md
View File

@@ -4,7 +4,6 @@
- [`boost_setup`](#boost_setup)
- [`import_versions`](#import_versions)
- [`import_archives_release_data`](#import_archives_release_data)
- [`import_artifactory_release_data`](#import_artifactory_release_data)
- [`update_libraries`](#update_libraries)
- [`import_library_versions`](#import_library_versions)
- [`import_library_version_docs_urls`](#import_library_version_docs_urls)
@@ -49,16 +48,16 @@ Imports `Version` objects from GitHub.
**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. |
| Options | Format | Description |
|----------------------|--------|---------------------------------------------------------------------------------------------------------|
| `--delete-versions` | bool | If passed, will delete all Version objects before importing Versions. |
| `--new` | bool | Default: 'true'. If 'true', will import only new Version objects. Set to 'false' to import all versions |
| `--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
- Loops through all tags, and discards any that do not match our inclusion logic, by default only versions that haven't already been imported.
- For each successful tag, import it as a `Version` object
- Then, run the command to the release downloads from Artifactory as `VersionFile` objects
@@ -76,40 +75,16 @@ Import `VersionFile` objects from Artifactory.
**Options**
| Options | Format | Description |
|----------------------|--------|--------------------------------------------------------------|
| `--release` | string | Format: `boost-1.63.0`. If passed, will import Archive urls for only that version. |
| Options | Format | Description |
|------------|--------|------------------------------------------------------------------------------------------------------------------------------|
| `--new` | bool | Default: 'true'. If 'true', will import only the newest release data. Set to 'false' to import archive data for all releases |
| `--release` | string | Format: `boost-1.63.0`. If passed, will import Archive urls for only that release. Overrides --new |
**More Information**
- Loops through `Version` objects and calls the task that retrieves the Archives data with the version information
- Loops through `Version` objects, by default only the most recent one, and calls the task that retrieves the Archives data with the version information
- Saves the Archives JSON data as `VersionFile` objects
## `import_artifactory_release_data`
*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**
```bash
./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
## `update_libraries`
**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.
@@ -138,14 +113,15 @@ Import `VersionFile` objects from Artifactory.
**Options**
| Options | Format | Description |
|----------------------|--------|--------------------------------------------------------------|
| `--token` | string | GitHub API Token. If passed, will use this value. If not passed, will use the value in settings. |
| 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.) |
| `--new` | bool | Default: 'true'. If 'true', will import data for the newest release. Set to 'false' to import library version data for all releases |
**Process**
- Loops through `Version` objects based on passed-in options
- Loops through `Version` objects based on passed-in options, by default just the most recent one.
- 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's `meta/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

12
docs/release_downloads.md
View File

@@ -1,12 +0,0 @@
# Boost Release Downloads
## Artifactory
- Populate the release downloads by running `./manage.py import_artifactory_release_data`. See [Management Commands](./commands.md#import_artifactory_release_data) for more information.
- Downloads for new versions populate as part of the new version import process
- Existing data can be refreshed by running `./manage.py import_artifactory_release_data` in the desired environment
- Environment variables: `ARTIFACTORY_URL` and `MIN_ARTIFACTORY_RELEASE`. See the [Envrionment Variables](./env_vars.md) for more information.
The Artifactory API URL in `ARTIFACTORY_URL` allows us to retrieve the data about the downloads from the Artifactory API.
The URLs for the downloads themselves are retrieved from the URLs provided to us by the Artifactory API. We don't generate the download links ourselves.