Skip to content
This repository has been archived by the owner on Oct 9, 2023. It is now read-only.

Update release notes workflow #41

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

dmitrii-ubskii
Copy link
Member

@dmitrii-ubskii dmitrii-ubskii commented May 5, 2023

What is the goal of this PR?

We integrate the new release notes tooling. The release notes are now to be written by a person and committed to the repo.

What are the changes implemented in this PR?

tools/release/create_notes.sh is a manual replacement for automatic @vaticle_dependencies//tool/release/notes:create in CI. The script is meant to be executed manually by the writer of the release notes, who will edit the autocompiled notes before committing LATEST_RELEASE_NOTES.md to the repository.

In the Release job in Factory, we check to see whether there were any changes committed since the release notes have last been changed, as a safeguard against accidentally releasing with stale release notes.

@typedb-bot
Copy link
Member

PR Review Checklist

Do not edit the content of this comment. The PR reviewer should simply update this comment by ticking each review item below, as they get completed.


Trivial Change

  • This change is trivial and does not require a code or architecture review.

Code

  • Packages, classes, and methods have a single domain of responsibility.
  • Packages, classes, and methods are grouped into cohesive and consistent domain model.
  • The code is canonical and the minimum required to achieve the goal.
  • Modules, libraries, and APIs are easy to use, robust (foolproof and not errorprone), and tested.
  • Logic and naming has clear narrative that communicates the accurate intent and responsibility of each module (e.g. method, class, etc.).
  • The code is algorithmically efficient and scalable for the whole application.

Architecture

  • Any required refactoring is completed, and the architecture does not introduce technical debt incidentally.
  • Any required build and release automations are updated and/or implemented.
  • Any new components follows a consistent style with respect to the pre-existing codebase.
  • The architecture intuitively reflects the application domain, and is easy to understand.
  • The architecture has a well-defined hierarchy of encapsulated components.
  • The architecture is extensible and scalable.

@dmitrii-ubskii dmitrii-ubskii changed the title new release notes tooling (pre-dependency propagation) Update release notes workflow May 23, 2023
@sync-by-unito sync-by-unito bot closed this May 26, 2023
@dmitrii-ubskii dmitrii-ubskii marked this pull request as ready for review May 30, 2023 11:01
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants