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.

Sign up for GitHub

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

Jump to bottom

Remove Cloud Providers related docs #5279

Merged
merged 1 commit into from
Oct 11, 2024
Merged

Remove Cloud Providers related docs #5279

merged 1 commit into from
Oct 11, 2024

Conversation

khanhtc1202
Copy link
Member

What this PR does:

Why we need it:

We deprecated this config 2 years ago

Which issue(s) this PR fixes:

Fixes #

Does this PR introduce a user-facing change?:

  • How are users affected by this change:
  • Is this breaking change:
  • How to migrate (if breaking change):

@khanhtc1202 khanhtc1202 enabled auto-merge (squash) October 11, 2024 07:28
@codecov Codecov
Copy link

codecov bot commented Oct 11, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 24.31%. Comparing base (45e18f7) to head (a3e8019).
Report is 1 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #5279      +/-   ##
==========================================
- Coverage   24.32%   24.31%   -0.01%     
==========================================
  Files         440      440              
  Lines       46784    46784              
==========================================
- Hits        11380    11376       -4     
- Misses      34501    34504       +3     
- Partials      903      904       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

t-kikuc
t-kikuc approved these changes Oct 11, 2024
View reviewed changes
Copy link
Member

@t-kikuc t-kikuc left a comment

Choose a reason for hiding this comment

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

Thank you 👍

Warashi
Warashi reviewed Oct 11, 2024
View reviewed changes
Copy link
Contributor

@Warashi Warashi left a comment

Choose a reason for hiding this comment

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

IMHO, the deletion of the deprecated config is not a breaking change, but it's a similar one. So we should not include them as a patch release.

docs/content/en/docs-v0.49.x/user-guide/managing-piped/adding-a-cloud-provider.md
Copy link
Contributor

Choose a reason for hiding this comment

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

IMHO, it's better to leave v0.49.x docs because we promise the patch releases don't include breaking changes.

pipecd/RELEASES.md

Line 50 in 45e18f7

This may also contain some minor features, but ensure that it does NOT contain any breaking changes.

Copy link
Member Author

Choose a reason for hiding this comment

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

In this PR, I only want to not mention the CloudProviders in docs to less confuse the newcomers. The old users have already known about the CloudProviders -> PlatformProviders for a while now (we could assume that since this config was marked as deprecated 2 years ago). So I think remove the docs is okay, it's also not a breaking change or any

Copy link
Contributor

Choose a reason for hiding this comment

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

Okay, I got your point.

@khanhtc1202 khanhtc1202 merged commit 7da4bd5 into master Oct 11, 2024
17 of 18 checks passed
@khanhtc1202 khanhtc1202 deleted the remove-cloudprovider-docs branch October 11, 2024 09:00
t-kikuc pushed a commit to t-kikuc/pipecd that referenced this pull request Oct 11, 2024
@khanhtc1202 @t-kikuc
Remove Cloud Providers related docs (pipe-cd#5279)
6d8b552 
Signed-off-by: khanhtc1202 <[email protected]>
t-kikuc added a commit to t-kikuc/pipecd that referenced this pull request Oct 11, 2024
@t-kikuc @khanhtc1202
CherryPick: x2 (#22)
755090c 
* Separate What and Why (pipe-cd#5278)

Signed-off-by: t-kikuc <[email protected]>

* Remove Cloud Providers related docs (pipe-cd#5279)

Signed-off-by: khanhtc1202 <[email protected]>

---------

Signed-off-by: t-kikuc <[email protected]>
Signed-off-by: khanhtc1202 <[email protected]>
Co-authored-by: Khanh Tran <[email protected]>
@github-actions github-actions bot mentioned this pull request Nov 7, 2024
Merged
@github-actions github-actions bot mentioned this pull request Nov 20, 2024
Merged
@github-actions github-actions bot mentioned this pull request Dec 3, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@t-kikuc t-kikuc t-kikuc approved these changes

@Warashi Warashi Warashi approved these changes

@nghialv nghialv Awaiting requested review from nghialv

@kentakozuka kentakozuka Awaiting requested review from kentakozuka

@ffjlabo ffjlabo Awaiting requested review from ffjlabo ffjlabo is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@khanhtc1202 @Warashi @t-kikuc