Skip to content

Conversation

@heavyscientist
Copy link
Contributor

@heavyscientist heavyscientist commented Feb 18, 2025

Add download_links file and strengthen filename uniqueness

Changes Made

Describe the changes you've made in this pull request. What does this PR do?

  • Downloads an additional file alongside the map/images. It's a json file (named similarly to its associated map) that contains download links for future use/reference.
  • Added more map characteristics (saved config, staging) to the filename convention for downloads

Motivation and Context

Why is this change required? What problem does it solve?

  • Allows external tools to:
    • find the maps easier
    • perform arbitrary work on the maps and images

If it fixes an open issue, please link to the issue here.

Type of Change

Please check the options that are relevant:

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • This change requires a documentation update

Testing Performed

Describe the tests you ran to verify your changes:

  • tests running in ci
  • tested locally and on a remote machine

Screenshots (if appropriate)

Add screenshots to help explain your changes.

naming convention is now $seed_$size_$saved_config_$staging_$mapid_...json

clipboard_2025-02-17_16-36

Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@github-actions
Copy link

github-actions bot commented Feb 18, 2025

badge

Code Coverage Summary

Filename                    Stmts    Miss  Cover    Missing
------------------------  -------  ------  -------  ------------------------------------------------------------------------------
rustmaps.go                     1       0  100.00%
pkg/api/generate.go            98      37  62.24%   65, 72, 92-93, 115, 125-138, 156, 163, 173-174, 183-184, 191-205, 210, 221-226
pkg/api/limits.go              27      10  62.96%   50-51, 60-61, 70-71, 78-79, 84-85
pkg/api/main.go                11       0  100.00%
pkg/api/status.go              41       6  85.37%   90, 99-100, 109-110, 119
pkg/rustmaps/generate.go       29       5  82.76%   25, 29, 35-36, 51
pkg/rustmaps/helpers.go        21       0  100.00%
pkg/rustmaps/import.go         98      13  86.73%   34, 45, 50, 106-107, 159-160, 166-167, 179-180, 187-188
pkg/rustmaps/download.go       80      19  76.25%   38-39, 56-57, 63-64, 97-98, 102, 120-121, 125-126, 134-135, 138-139, 142-143
pkg/rustmaps/config.go         13       3  76.92%   25-27, 34
pkg/rustmaps/getters.go         5       0  100.00%
pkg/rustmaps/main.go           43       4  90.70%   52, 70, 111-112
pkg/rustmaps/setters.go         3       0  100.00%
pkg/rustmaps/auth.go           15       4  73.33%   26-27, 34-35
pkg/types/main.go              38       2  94.74%   106, 114
TOTAL                         523     103  80.31%

Results for commit: 68a1647

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

nvgscientist
nvgscientist previously approved these changes Feb 18, 2025
Copy link
Contributor

@nvgscientist nvgscientist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 💯

@heavyscientist heavyscientist merged commit 3ab66c8 into main Feb 18, 2025
3 checks passed
@heavyscientist heavyscientist deleted the downloads_naming branch February 18, 2025 01:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants