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

Refactor management commands***

Browse Source 
***Updated command names and added new command for importing beta releases. Replaced `import_artifactory_release_data` with `import_archives_release_data`.***

***Updated documentation for `import_archives_release_data` command.***

***Updated documentation for `import_artifactory_release_data` command to indicate it has been replaced by `import_archives_release_data`.
This commit is contained in:
Kenneth Reitz
2024-04-02 17:14:40 -04:00
parent 88732f35d1
commit 8fd4f33f62
1 changed files with 37 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
docs/commands.md
View File

@@ -1,14 +1,17 @@
# Management Commands
- [`boost_setup`](#boost_setup)
- [`import_versions`](#import_versions)
- [`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)
- [`update_maintainers`](#update_maintainers)
- [`update_authors`](#update_authors)
- [`import_commit_counts`](#import_commit_counts)
- [Management Commands](#management-commands)
- [`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)
- [`update_maintainers`](#update_maintainers)
- [`update_authors`](#update_authors)
- [`import_commit_counts`](#import_commit_counts)
- [`import_beta_release`](#import_beta_release)
## `boost_setup`
@@ -55,7 +58,7 @@ Imports `Version` objects from GitHub.
- For each successful tag, import it as a `Version` object
- Then, run the command to the release downloads from Artifactory as `VersionFile` objects
## `import_artifactory_release_data`
## `import_archives_release_data`
*This process is run automatically as part of `import_versions`.*
@@ -63,6 +66,30 @@ Import `VersionFile` objects from Artifactory.
**Example**
```bash
./manage.py import_archives_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 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
```