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

ci: removing dev comments before the release #1127

Merged
merged 19 commits into from
Dec 14, 2023
Merged

ci: removing dev comments before the release #1127

merged 19 commits into from
Dec 14, 2023

Conversation

drodriguez-305
Copy link
Contributor

@drodriguez-305 drodriguez-305 commented Dec 8, 2023

Which problem does the PR fix?

This PR will remove development notes in our values and manifest files. It was requested by support as some customers have been confused by these.

#1089

What's in this PR?

Created a script that will run in our release process that will remove all TODO and NOTES sections. The script will ignore any files that are located in the "./test" directory. It will also create a change log and upload as artifact for reference.

The script will be called from our chart-release.yaml before the actual release steps.

Checklist

Please make sure to follow our Contributing Guide.

Before opening the PR:

  • There is no other open pull request for the same update/change.

After opening the PR:

  • Did you sign our CLA (Contributor License Agreement)? It will show once you open the PR.
  • Did all checks/tests pass in the PR?

@drodriguez-305 drodriguez-305 added this to the 8.4 release milestone Dec 8, 2023
@drodriguez-305 drodriguez-305 requested a review from a team December 8, 2023 14:38
@drodriguez-305 drodriguez-305 self-assigned this Dec 8, 2023
@aabouzaid
Copy link
Member

@drodriguez-305 I like the script 😁

However, I believe it could be much simpler since we have everything in the repo.

First of all, we only need to remove the development comments, not all comments.
Second, we only need to remove the comments in static files like value.yaml file, but in the template, we can remove them by using template comments {{/* ... */}} so they will not be rendered for the end users.

So, the goal here is to simplify the script by fixing the root cause in the repo itself.

@github-actions github-actions bot temporarily deployed to gke-1127 December 11, 2023 19:55 Destroyed
@github-actions github-actions bot temporarily deployed to gke-1127-upgrade December 11, 2023 19:55 Destroyed
@github-actions github-actions bot temporarily deployed to rosa-1127-upgrade December 11, 2023 19:56 Destroyed
@github-actions github-actions bot temporarily deployed to gke-1127-upgrade December 11, 2023 20:00 Destroyed
@github-actions github-actions bot temporarily deployed to rosa-1127 December 11, 2023 20:00 Destroyed
@github-actions github-actions bot temporarily deployed to rosa-1127-upgrade December 11, 2023 20:00 Destroyed
@github-actions github-actions bot temporarily deployed to gke-1127 December 11, 2023 20:00 Destroyed
@github-actions github-actions bot temporarily deployed to gke-1127 December 11, 2023 20:45 Destroyed
@github-actions github-actions bot temporarily deployed to gke-1127-upgrade December 11, 2023 20:45 Destroyed
@github-actions github-actions bot temporarily deployed to rosa-1127 December 11, 2023 20:45 Destroyed
@github-actions github-actions bot temporarily deployed to rosa-1127-upgrade December 11, 2023 20:45 Destroyed
@aabouzaid aabouzaid requested review from aabouzaid and removed request for a team December 11, 2023 20:52
@aabouzaid aabouzaid marked this pull request as draft December 11, 2023 20:52
@github-actions github-actions bot temporarily deployed to gke-1127 December 11, 2023 21:25 Destroyed
@github-actions github-actions bot temporarily deployed to gke-1127 December 13, 2023 14:00 Destroyed
@github-actions github-actions bot temporarily deployed to gke-1127-upgrade December 13, 2023 14:00 Destroyed
@github-actions github-actions bot temporarily deployed to rosa-1127-upgrade December 13, 2023 14:00 Destroyed
@github-actions github-actions bot temporarily deployed to gke-1127 December 13, 2023 16:24 Destroyed
@github-actions github-actions bot temporarily deployed to rosa-1127 December 13, 2023 16:24 Destroyed
@github-actions github-actions bot temporarily deployed to gke-1127-upgrade December 13, 2023 16:24 Destroyed
@github-actions github-actions bot temporarily deployed to rosa-1127-upgrade December 13, 2023 16:24 Destroyed
@github-actions github-actions bot temporarily deployed to gke-1127-upgrade December 13, 2023 16:39 Destroyed
@github-actions github-actions bot temporarily deployed to gke-1127 December 13, 2023 16:39 Destroyed
@github-actions github-actions bot temporarily deployed to rosa-1127 December 13, 2023 16:39 Destroyed
@github-actions github-actions bot temporarily deployed to rosa-1127-upgrade December 13, 2023 16:39 Destroyed
@github-actions github-actions bot temporarily deployed to gke-1127 December 14, 2023 13:16 Destroyed
@github-actions github-actions bot temporarily deployed to gke-1127-upgrade December 14, 2023 13:16 Destroyed
@github-actions github-actions bot temporarily deployed to rosa-1127 December 14, 2023 13:16 Destroyed
@github-actions github-actions bot temporarily deployed to rosa-1127-upgrade December 14, 2023 13:16 Destroyed
@github-actions github-actions bot temporarily deployed to gke-1127 December 14, 2023 13:21 Destroyed
@github-actions github-actions bot temporarily deployed to rosa-1127-upgrade December 14, 2023 13:21 Destroyed
@github-actions github-actions bot temporarily deployed to gke-1127-upgrade December 14, 2023 13:21 Destroyed
@github-actions github-actions bot temporarily deployed to rosa-1127 December 14, 2023 13:21 Destroyed
@aabouzaid aabouzaid changed the title ci: Removing development notes from manifest and values files. ci: removing dev comments before the release Dec 14, 2023
Copy link
Member

@aabouzaid aabouzaid left a comment

Choose a reason for hiding this comment

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

All looks good, thanks a lot 🚀

@aabouzaid aabouzaid merged commit 793544e into main Dec 14, 2023
9 of 11 checks passed
@aabouzaid aabouzaid deleted the remove_dev_notes branch December 14, 2023 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ci cleanup Relating to code cleanup, resolving technical debt, or process cleanup
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[TASK] Remove development notes from the chart before releasing it
2 participants