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

add versioned docs #1645

Merged
merged 4 commits into from
Nov 9, 2021
Merged

Conversation

sozercan
Copy link
Member

@sozercan sozercan commented Nov 5, 2021

Signed-off-by: Sertac Ozercan [email protected]

What this PR does / why we need it:

  • tag version for docs as part of release (e.g., make version-docs NEWVERSION=v3.7.x), see updated release doc
  • this will create following files and directories that will need to be merged in with the release PR
	versioned_docs/
	versioned_sidebars/
	versions.json
  • after the release PR is merged, versioned docs will be generated in website

example: https://sozercan.github.io/gatekeeper/website/docs/ (see upper right)

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):
Fixes #1185

Special notes for your reviewer:

Signed-off-by: Sertac Ozercan <[email protected]>
@codecov-commenter
Copy link

codecov-commenter commented Nov 5, 2021

Codecov Report

Merging #1645 (c1747d2) into master (87cb662) will decrease coverage by 0.26%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1645      +/-   ##
==========================================
- Coverage   52.81%   52.54%   -0.27%     
==========================================
  Files          98       98              
  Lines        8591     8591              
==========================================
- Hits         4537     4514      -23     
- Misses       3695     3715      +20     
- Partials      359      362       +3     
Flag Coverage Δ
unittests 52.54% <ø> (-0.27%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
pkg/readiness/list.go 79.41% <0.00%> (-11.77%) ⬇️
...onstrainttemplate/constrainttemplate_controller.go 55.21% <0.00%> (-4.51%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 87cb662...c1747d2. Read the comment docs.

Signed-off-by: Sertac Ozercan <[email protected]>
@sozercan sozercan requested a review from a team November 5, 2021 20:02
Copy link
Contributor

@maxsmythe maxsmythe left a comment

Choose a reason for hiding this comment

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

LGTM, thank you for doing this!

docs/RELEASE.md Outdated
@@ -56,9 +56,16 @@ Cherry pick script is copied over from https://github.com/kubernetes/kubernetes/
make promote-staging-manifest
```

1. If it's a new minor release (e.g. v3.7.0), tag docs to be versioned.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit, use a before and after if you want to clarify (v3.6.x -> 3.7.0)

Copy link
Member Author

Choose a reason for hiding this comment

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

updated.

Copy link
Member Author

@sozercan sozercan Nov 5, 2021

Choose a reason for hiding this comment

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

@maxsmythe thoughts on if we should call NEWVERSION v3.7.0 or v3.7.x?

Copy link
Member Author

Choose a reason for hiding this comment

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

.x makes sense since ideally all patch versions shouldn't have behavior changes and it's more clear that it applies to all

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm okay with either. Usually a new minor version starts at patch zero, but keeping x for both is clearer.

Signed-off-by: Sertac Ozercan <[email protected]>
Signed-off-by: Sertac Ozercan <[email protected]>
@sozercan
Copy link
Member Author

sozercan commented Nov 5, 2021

fyi @ritazh @shomron

@sozercan sozercan merged commit 2047863 into open-policy-agent:master Nov 9, 2021
@sozercan sozercan deleted the docs-versioned branch November 9, 2021 17:52
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.

add versioning to docs
3 participants