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

update release readme #1147

Merged
merged 1 commit into from
Sep 20, 2024
Merged

update release readme #1147

merged 1 commit into from
Sep 20, 2024

Conversation

skudasov
Copy link
Collaborator

@skudasov skudasov commented Sep 20, 2024 •
edited by github-actions bot
Loading

Below is a summarization created by an LLM (gpt-4-0125-preview). Be mindful of hallucinations and verify accuracy.

Why

The updates refine the release process documentation for the Chainlink Testing Framework, focusing on best practices for managing breaking changes and enhancing clarity on how to handle releases. This ensures a more streamlined and error-free release process.

What

  • README.md
    • Added a new section titled "Releasing" with a brief overview on following SemVer and Go practices, and a link to detailed instructions in RELEASE.md. This addition clarifies the release process directly within the project's main documentation.
  • RELEASE.md
    • Updated the document to reflect a more structured and clear release strategy specifically tailored to the Chainlink Testing Framework, including handling breaking changes, the procedure for minor and patch releases, and major releases, as well as detailing steps for binary releases and debugging the release pipeline. The changes aim to simplify the release process and make it more transparent.

@skudasov skudasov marked this pull request as ready for review September 20, 2024 08:49
@skudasov skudasov requested review from sebawo and a team as code owners September 20, 2024 08:49
@cl-sonarqube-production
Copy link

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@skudasov skudasov merged commit a197ef9 into main Sep 20, 2024
45 checks passed
@skudasov skudasov deleted the update-release-readme branch September 20, 2024 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gheorghestrimtu gheorghestrimtu gheorghestrimtu approved these changes

@sebawo sebawo Awaiting requested review from sebawo sebawo 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.
2 participants
@skudasov @gheorghestrimtu