Gitea: Add field for release notes PR in PR template #118324

Open
Julian Eisel wants to merge 1 commits from JulianEisel/blender:main into main

When changing the target branch, be careful to rebase the branch in your fork to match. See documentation.
Member

All user visible changes should be added to the release notes, ideally together with pushing the actual change. However, nothing in the process enforces that. The new developer documentation enables PRs for the release notes, so it's now possible (and highly encouraged) to prepare the release notes changes in a PR. Still, there's no mention of this in the process of creating a PR that would reinforce that.

With this change, we explicitly (but optionally) ask for the link to such a release notes PR when creating a PR for the Blender repository. This should help making this good practice more common practice.


When creating a PR, there's the following new section:

Once the PR is created, it's displayed in the PR description like this:

We could ask for other documentation PR links, but this is the most important one to include.

All user visible changes should be added to the release notes, ideally together with pushing the actual change. However, nothing in the process enforces that. The new developer documentation enables PRs for the release notes, so it's now possible (and highly encouraged) to prepare the release notes changes in a PR. Still, there's no mention of this in the process of creating a PR that would reinforce that. With this change, we explicitly (but optionally) ask for the link to such a release notes PR when creating a PR for the Blender repository. This should help making this good practice more common practice. --- When creating a PR, there's the following new section: <img src="/attachments/2ab54f12-2422-4a79-a6b4-0d904780aedb" width=450/> Once the PR is created, it's displayed in the PR description like this: <img src="/attachments/664ced1e-5fb8-4c65-9893-4b637af68251" width=450/> We could ask for other documentation PR links, but this is the most important one to include.
Julian Eisel added 1 commit 2024-02-15 13:12:15 +01:00
Julian Eisel added the
Interest
Development Management
label 2024-02-15 13:15:37 +01:00
Julian Eisel requested review from Brecht Van Lommel 2024-02-15 13:15:51 +01:00
Julian Eisel requested review from Thomas Dinges 2024-02-15 13:15:51 +01:00
Julian Eisel added 1 commit 2024-02-15 14:46:22 +01:00
Thomas Dinges approved these changes 2024-02-15 15:18:48 +01:00
Thomas Dinges left a comment
Owner

Useful to have!

Useful to have!
Brecht Van Lommel requested changes 2024-02-15 17:39:06 +01:00
Brecht Van Lommel left a comment
Owner

While I would like contributors to add release notes, for me this workflow is not convenient enough to recommend.

It's too tedious for contributors to fork and make a pull request to add a line of text. Nor is the process documented.

As a reviewer for a relatively new contributor, I will probably want to tweak the wording or fix formatting issues, going through another PR feedback cycle usually would take more time than just editing the release notes myself.

While I would like contributors to add release notes, for me this workflow is not convenient enough to recommend. It's too tedious for contributors to fork and make a pull request to add a line of text. Nor is the process documented. As a reviewer for a relatively new contributor, I will probably want to tweak the wording or fix formatting issues, going through another PR feedback cycle usually would take more time than just editing the release notes myself.
Julian Eisel force-pushed main from 44eab6a95d to d7a7491518 2024-07-15 18:19:30 +02:00 Compare
Julian Eisel added 1 commit 2024-07-19 16:23:35 +02:00
Switching to an asset browser, then back to a differend editor would
cause a crash when loading a new file.

Basically the file/asset browser tried to free dangling asset and asset
library pointers when trying to free itself. That's because the asset
system gets destructed with a `AS_asset_libraries_exit()` call before
the screen and with that the asset browser were freed.

More context:
- The file list has pointers to assets owned by the asset system
- The pointers are non-owning, however the file-list manages loading and
  unloading of the assets into/from the asset libraries.
- This creates a tricky to manage lifetime dependency between the file
  list and the asset library storage.

In C++, `std::weak_ptr` can be used for such circular dependencies. The
owner uses a shared, the non-owner uses a weak pointer. Whenever the
non-owner accesses the object, it first checks if the object is still
alive through the weak pointer interface.

Unfortunately this adds some noice in the changes:
- Assets need to be stored as shared pointers
- `FileListInternEntry` needs to be non-trivial to hold weak pointers.
  I added explicit member initializers for all members to make sure the
  result matches the previous `MEM_cnew()` call still, to play safe.
This pull request can be merged automatically.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u main:JulianEisel-main
git checkout JulianEisel-main
Sign in to join this conversation.
No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset System
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Asset Browser Project
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No project
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#118324
No description provided.