Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: schema version mapping #8973

Merged

Conversation

ericzzzzzzz
Copy link
Contributor

@ericzzzzzzz ericzzzzzzz commented Jul 26, 2023

Fixes: #8925

Descriptions

  • add bin schema version mapping json files to store bin-schema mapping info, so we can use to get related data when users query a schema. Those files are generated with the script here
#!/bin/bash

for e in $(gh release list -L 1000 | awk '{print $1}'); do

    output=$(gh release view $e)
#    echo "$output"
    if [[ $output =~ This\ release\ comes\ with\ a\ new\ config\ version,\ \`v[0-9]+(alpha|beta)?[0-9]*\` ]]; then

      c=$(echo "${BASH_REMATCH[n]}"| ggrep -oP 'v[0-9]+(alpha|beta)?[0-9]*')

      echo "bin version $e, schema version $c"
      binVersion=${e%v}
      link="https://github.com/GoogleContainerTools/skaffold/releases/tag/${e}"
      jq -n --arg binVersion $binVersion --arg link $link '{
        "binVersion": $binVersion,
        "releaseNoteLink": $link
        }' > "docs-v2/content/en/schemas/version-mappings/${c}-version.json"
    fi
done
  • update corresponding docs.
  • move and update release/main.go to generate the corresponding version mapping file when there is a release with schema change.
    Test Plan
  • run make preview-docs-v2, and go to skaffold.yaml tab, should see the note here
    Screenshot 2023-07-26 at 10 38 01 AM

@ericzzzzzzz ericzzzzzzz changed the title [docs] schema version mapping docs: schema version mapping Jul 26, 2023
@codecov
Copy link

codecov bot commented Jul 26, 2023

Codecov Report

Merging #8973 (9fac865) into main (290280e) will decrease coverage by 6.87%.
Report is 983 commits behind head on main.
The diff coverage is 50.29%.

@@            Coverage Diff             @@
##             main    #8973      +/-   ##
==========================================
- Coverage   70.48%   63.62%   -6.87%     
==========================================
  Files         515      624     +109     
  Lines       23150    31935    +8785     
==========================================
+ Hits        16317    20318    +4001     
- Misses       5776    10086    +4310     
- Partials     1057     1531     +474     
Files Changed Coverage Δ
cmd/skaffold/app/cmd/completion.go 13.04% <0.00%> (-1.25%) ⬇️
cmd/skaffold/app/cmd/config/list.go 65.21% <ø> (ø)
cmd/skaffold/app/cmd/config/set.go 88.72% <ø> (ø)
cmd/skaffold/app/cmd/config/util.go 54.28% <ø> (ø)
cmd/skaffold/app/cmd/credits.go 100.00% <ø> (ø)
cmd/skaffold/app/cmd/credits/export.go 0.00% <0.00%> (ø)
cmd/skaffold/app/cmd/deploy.go 40.90% <0.00%> (-12.94%) ⬇️
cmd/skaffold/app/cmd/generate_pipeline.go 60.00% <ø> (ø)
cmd/skaffold/app/cmd/inspect_modules.go 65.00% <ø> (ø)
cmd/skaffold/app/cmd/inspect_profiles.go 66.66% <ø> (ø)
... and 40 more

... and 416 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@ericzzzzzzz ericzzzzzzz marked this pull request as ready for review July 26, 2023 15:05
@ericzzzzzzz ericzzzzzzz merged commit 21602b7 into GoogleContainerTools:main Jul 28, 2023
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

document skaffold bin and skaffold schema mappings
2 participants