Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion developer_manual/app_publishing_maintenance/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ App publishing and maintenance

Transforming source files into a deliverable is documented in the :ref:`app-release-process`.

.. note::

For the latest release notes, critical API changes and deprecations, see the :doc:`Release Notes </release_notes/index>`.

.. toctree::
:maxdepth: 2

Expand All @@ -14,4 +18,3 @@ Transforming source files into a deliverable is documented in the :ref:`app-rele
publishing
code_signing
release_automation
app_upgrade_guide/index
8 changes: 7 additions & 1 deletion developer_manual/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -174,9 +174,15 @@
"core/static-analysis": "../server/static-analysis.html",
"core/unit-testing": "../server/unit-testing.html",
# Removed 2024-09
"digging_deeper/changelog": "../app_publishing_maintenance/app_upgrade_guide/index.html",
"digging_deeper/changelog": "../release_notes/index.html",
# Removed 2025-04
"basics/front-end/l10n": "../translations.html",
# Moved 2026-04 - Upgrade to 34 moved to release notes
"app_publishing_maintenance/app_upgrade_guide/upgrade_to_34": "../../release_notes/critical_changes.html",
# Moved 2026-04 - Previous versions moved to release notes
"app_publishing_maintenance/app_upgrade_guide/index": "../../release_notes/index.html",
"app_publishing_maintenance/app_upgrade_guide/upgrade_to_33": "../../release_notes/previous/upgrade_to_33.html",
"app_publishing_maintenance/app_upgrade_guide/upgrade_to_32": "../../release_notes/previous/upgrade_to_32.html",
"app_publishing_maintenance/app_upgrade_guide/upgrade_to_31": "../../release_notes/previous/upgrade_to_31.html",
"app_publishing_maintenance/app_upgrade_guide/upgrade_to_30": "../../release_notes/previous/upgrade_to_30.html",
}
2 changes: 1 addition & 1 deletion developer_manual/prologue/compatibility_app_ecosystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ There are three procedures in place to facilitate communication to app developer

This means the development of your pull request cannot be considered done if you introduced changes (additions, removals or modifications) that affect app developers that you did not document.

2. A change necessary for app developers to execute for app compatibility in a new version, has to be reported and documented by the author of the pull request in the :ref:`App Upgrade guide <app-upgrade-guide>` section.
2. A change necessary for app developers to execute for app compatibility in a new version, has to be reported and documented by the author of the pull request in the :ref:`Release Notes <critical-changes>` section.

The requirements for this documentation are:

Expand Down
4 changes: 2 additions & 2 deletions developer_manual/release_notes/deprecations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ Older deprecations
You find all current deprecations in this section.

..
This is where we will move the deprecations after the branch off. Enties will stay until actual removal.
This is where we will move the deprecations after the branch off. Entries will stay until actual removal.
Also see the older :ref:`app-upgrade-guide` for deprecations.
Also see the older :ref:`Release Notes <previous-versions>` for deprecations.
2 changes: 2 additions & 0 deletions developer_manual/release_notes/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ On this page you will find:
- :ref:`critical-changes` - Critical changes that must be addressed for app compatibility
- :ref:`new-apis` - New developer APIs and features
- :ref:`deprecated-apis` - Deprecated APIs and their removal timeline
- :ref:`previous-versions` - Critical changes and deprecations of previous Nextcloud versions

.. toctree::
:maxdepth: 3
Expand All @@ -17,3 +18,4 @@ On this page you will find:
critical_changes
new
deprecations
previous/index
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _app-upgrade-guide:
.. _previous-versions:

=================
App upgrade guide
=================
======================
Previous release notes
======================

Once you've created and published the first version of your app, you will want to keep it up to date with the latest Nextcloud features.

Expand Down
6 changes: 4 additions & 2 deletions developer_manual/server/code-back-end.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,7 @@ Compatibility documentation
---------------------------

- New APIs (interfaces, constants, methods, classes, traits, enums) added to the public namespace ``OCP`` have to be annotated with a ``@since X.Y.Z`` attribute of the version it was added in.
- When it is backported the version should be adjusted to the X.Y.Z of the stable version it was backported in only in that stable branch. The master branch should still contain the newest Major version shipping the API.
- Once an API was shipped, unless it is marked as experimental, it has to be deprecated in similar fashion using ``@deprecated X.Y.Z`` for 3 years (9 Nextcloud releases) before it can be removed. Deprecations have to be clearly documented in the :ref:`app-upgrade-guide` for the upcoming Major version.
- When it is backported the version should be adjusted to the X.Y.Z of the stable version it was backported in only in that stable branch.
The master branch should still contain the newest Major version shipping the API.
- Once an API was shipped, unless it is marked as experimental, it has to be deprecated in similar fashion using ``@deprecated X.Y.Z`` for 3 years (9 Nextcloud releases) before it can be removed.
Deprecations have to be clearly documented in the :ref:`critical-changes` for the upcoming Major version.
Loading