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

📖 Update docs with the changes made for 4.3.0 release #4224

Merged
merged 159 commits into from
Oct 22, 2024
Merged

Conversation

camilamacedo86
Copy link
Member

@camilamacedo86 camilamacedo86 commented Oct 22, 2024

Update docs with the changes made for 4.3.0 release

Closes: #4214

camilamacedo86 and others added 30 commits August 8, 2024 08:25
✨ (go/v4): Added DevContainer support for seamless development in environments like GitHub Workspaces without local setup.
Now that we have the Getting Started guide, which provides a solid overview, the most appropriate next step seems to be following this guide. Lastly, we are removing the note from the DeployImage section as it doesn't seem to fit well on this page.

See that now we have the Getting Started which provides a good overview
so the most approprieted next step shows to be this one. By last, we are removing the note from DeployImage it does not seems to fit well in this page
📖 update the next step from quick start accordingly
doc: provide better info about usage of kind
… Instructions (#4093)

This pull request includes several small but important improvements to the documentation, aimed at enhancing clarity and providing additional resources:

- Added a link to the CronJob Tutorial in the "Next Steps" section of the Getting Started guide.
- Fixed minor issues with documentation headings and improved consistency in the Quick Start guide.
- Clarified the need to push images in the Running guide with an added note.
- Recommended using Kind for testing in the Getting Started guide.
- Corrected a typo in the link to the Kind guide.
- Added a brief note in the "Next Steps" section about the Deploy Image plugin to offer further guidance.
…ed github action (#4095)

The kubebuilder-release-tools project is no longer really maintained. The image required for checks is deprecated due
the infrastructure used to build and promote it be deprecated. Given the minimal nature of the check, it's unnecessary to maintain a GitHub Action for this purpose.

Also, it broke 1 day ago. Note that we need to pass permissions via GitHub Token, which is not very safe. This is another reason why we need to proceed with these changes.
…hecker (#4097)

ci: Normalize text-based emoji codes to actual emojis in PR title checker

Follow up of: #4095
move pr title checker to be under test with ther others checks
The config/sample generated when we are using the plugin was missing the labels

````yaml
  labels:
    app.kubernetes.io/name: {{ .ProjectName }}
    app.kubernetes.io/managed-by: kustomize
```:wq
… and reconciliation logic

Added detailed comments in the SetupManager scaffold within the controller to explain how the resource watching and reconciliation process works. These comments clarify how the controller watches for changes in Custom Resources and Deployments, ensuring that the cluster maintains the desired state.
…no longer supported and provided

Those flgas were added to allow users still using the versions v1beta1 which is no longer supported and
prvided since k8s 1.22 and were deprecated a long time ago and cannot be used with go/v4. Those are removed
since is no longer possible to support those older version with the dependencies versions used
currently. More info: #3622
🐛 (deploy-image/v1-alpha1): Fix typo issue by replacing typeNamespaceName with typeNamespacedName
📖 remove warning note which was valid for old k8s versions
🐛 (deploy-image/v1-alpha1): Fix sample by ensuring the right labels
📖 remove notes about crd-version and webhook-version flags which are no longer supported and provided
📖 fix link for reference doc to manager and crd scopes
Bumps [github.com/onsi/ginkgo/v2](https://github.com/onsi/ginkgo) from 2.20.0 to 2.20.1.
- [Release notes](https://github.com/onsi/ginkgo/releases)
- [Changelog](https://github.com/onsi/ginkgo/blob/master/CHANGELOG.md)
- [Commits](onsi/ginkgo@v2.20.0...v2.20.1)

---
updated-dependencies:
- dependency-name: github.com/onsi/ginkgo/v2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v3...v4)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
…ns/actions/checkout-4

🌱 Bump actions/checkout from 3 to 4
…ithub.com/onsi/ginkgo/v2-2.20.1

🌱 Bump github.com/onsi/ginkgo/v2 from 2.20.0 to 2.20.1
This PR fix the following issues:

```
$ make lint
testdata/project-v4/bin/golangci-lint run
cmd/main.go:154:37: string  has 3 occurrences, make it a constant (goconst)
if os.Getenv(ENABLE_WEBHOOKS) != false {
                                   ^
api/v1/firstmate_webhook.go:25:5: var  is unused (unused)
var firstmatelog = logf.Log.WithName(firstmate-resource)
```
 🐛  (go/v4): Fix linter issues in the scaffold
k8s-ci-robot and others added 17 commits October 9, 2024 13:02
…lease

📖  small fixes for the doc Using External Resources
Over time, this section has grown incrementally, leading to content duplication and outdated or irrelevant information. To address this, we are now:

- Re-organizing the structure for better clarity.
- Fixing broken or outdated links.
- Removing duplicated and obsolete content.
- Re-writing and refining parts of the sections to ensure accuracy and relevance.
- Ensuring the Kubebuilder layout doc's standards
📖 (doc) - refactory and clenup the Plugin section
cleanup/refactor: Alpha Generate command

- Refactored the code implementation to improve error handling, encapsulate logic, and streamline execution flow.
- Moved the code implementation from `pkg` to the CLI since it pertains directly to a command.
- Additionally, moved the implementation to `internal` to prevent exposing the `Generate` code and avoid unintentional extensions on this alpha feature.
…g webhookcainjection_patch. Clarifying replacements for cert-manager (#4123)

fix issues by simplifying the scaffold. Removes webhookcainjection_patch and clarify replacements.

- Removed config/default/webhookcainjection_patch.yaml to streamline the scaffold.
- Clarified replacements blocks in kustomization.yaml for easier understanding. Each block is now labeled with instructions for uncommenting based on specific webhook scenarios (ValidatingWebhook, DefaultingWebhook, ConvertingWebhook).
…to 0.77.1 (#4212)

Upgrade Prometheus Operator version used on the tests to 0.77.1
…th the latest changes in controller-runtime (#4216)

Update roadmap_2024.md
This update introduces support for scaffolding webhooks for external types, which are APIs/CRDs defined in other projects
… indicies with indices)

📖 (doc) - Fix typo issues in the tutorial scaffolded samples (replace  indicies with indices)
🐛 fixed Duplicate Webhook Patch Entries when Creating Multiple Ver…
✨ Add support to scaffold controllers for External Types
This update introduces support for scaffolding webhooks for Core Types, which are Kubernetes-native resources defined in the Kubernetes API.
…core-types

✨ Add Support for Scaffolding Webhooks for Core Types
… properly generate the sample for cert-manager.

- Allowing the domain be empty since some scenarios this value might not be required
- Use `io` as the domain to fix the scaffold sample for cert-manager and update the example in the documentation.
…ernal-types

🐛 fix support for external types by allowing the domain be empty, and properly generate the sample for cert-manager.
@k8s-ci-robot k8s-ci-robot added the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Oct 22, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Oct 22, 2024
@camilamacedo86 camilamacedo86 changed the title Update docs with the changes made for 4.3.0 release 📖 Update docs with the changes made for 4.3.0 release Oct 22, 2024
fix GoReleaser by adding permission to write content

We found an issue to publish the assets when we are trying to publish the release 4.3.0. Therefore, we are adding the content permission to verify if the issue can be solved within
@k8s-ci-robot
Copy link
Contributor

Keywords which can automatically close issues and at(@) or hashtag(#) mentions are not allowed in commit messages.

The list of commits with invalid commit messages:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@camilamacedo86 camilamacedo86 added lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. labels Oct 22, 2024
@k8s-ci-robot k8s-ci-robot merged commit 2a94da3 into book-v4 Oct 22, 2024
47 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants