Prepare 3.0.x-devel to become master (#750)

* Refs #20893: Add warning to intro page Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20893: Update PR template Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20893: Warning in README Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20893: Update mirror workflow Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20893: Apply Eliana's suggestions Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com>
eProsima · May 9, 2024 · 827bc03 · 827bc03
1 parent d6eeda0
commit 827bc03
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 2 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -19,7 +19,7 @@
     In case of bug fixes, please provide the list of supported branches where this fix should be also merged.
     Please uncomment following line, adjusting the corresponding target branches for the backport.
 -->
-<!-- @Mergifyio backport 2.13.x 2.10.x 2.6.x -->
+<!-- @Mergifyio backport 2.14.x 2.13.x 2.10.x 2.6.x -->
 
 <!-- If an issue is already opened, please uncomment next line with the corresponding issue number. -->
 <!-- Fixes #(issue) -->
@@ -35,6 +35,11 @@ Related implementation PR:
 
 ## Contributor Checklist
 
+<!--
+    - If any of the elements of the following checklist is not applicable, substitute the checkbox [ ] by _N/A_:
+    - If any of the elements of the following checklist is not fulfilled on purpose, please provide a reason and substitute the checkbox [ ] with ❌: or __NO__:.
+-->
+
 - [ ] Commit messages follow the project guidelines. <!-- External contributors should sign the DCO. Fast DDS docs developers must also refer to the internal Redmine task. -->
 - [ ] Code snippets related to the added documentation have been provided.
 - [ ] Documentation tests pass locally.

diff --git a/.github/workflows/mirror.yml b/.github/workflows/mirror.yml
@@ -3,16 +3,19 @@ on:
   push:
     branches:
       - 'master'
+      - '2.14.x'
 
 jobs:
-  mirror_job:
+  mirror_job_master:
+    if: github.ref == 'refs/heads/master'
     name: Mirror master branch to latest minor branches
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
         dest_branch:
           - '3.0.x'
+          - '3.x'
     steps:
     - name: Mirror action step
       id: mirror
@@ -21,3 +24,21 @@ jobs:
         github-token: ${{ secrets.GITHUB_TOKEN }}
         source: 'master'
         dest: ${{ matrix.dest_branch }}
+
+  mirror_job_2_x:
+    if: github.ref == 'refs/heads/2.14.x'
+    name: Mirror 2.14.x branch to latest minor branches
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        dest_branch:
+          - '2.x'
+    steps:
+    - name: Mirror action step
+      id: mirror
+      uses: eProsima/eProsima-CI/external/mirror-branch-action@main
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        source: '2.14.x'
+        dest: ${{ matrix.dest_branch }}
diff --git a/README.md b/README.md
@@ -4,6 +4,11 @@
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Linux Build Status](http://jenkins.eprosima.com:8080/job/nightly_fastdds-docs_master/badge/icon?subject=CI%20testing%20)](http://jenkins.eprosima.com:8080/job/nightly_fastdds-docs_master/)
 
+<!-- TODO(eduponz): Remove this before releasing v3.0.0 -->
+> [!WARNING]
+> **In preparation for v3.0.0, Fast DDS' master branch is undergoing major changes entailing API breaks.**
+> **Until Fast DDS v3.0.0 is released, it is strongly advisable to use the latest stable branch, [2.14.x](https://github.com/eProsima/Fast-DDS/tree/2.14.x).**
+
 <a href="http://www.eprosima.com"><img src="https://encrypted-tbn3.gstatic.com/images?q=tbn:ANd9GcSd0PDlVz1U_7MgdTe0FRIWD0Jc9_YH-gGi0ZpLkr-qgCI6ZEoJZ5GBqQ" align="left" hspace="8" vspace="2" width="100" height="100" ></a>
 
 *eprosima Fast DDS* (formerly Fast RTPS) is a C++ implementation of the DDS (Data Distribution Service) standard of the OMG (Object Management Group). eProsima Fast DDS implements the RTPS (Real Time Publish Subscribe) protocol, which provides publisher-subscriber communications over unreliable transports such as UDP,

diff --git a/docs/02-formalia/titlepage.rst b/docs/02-formalia/titlepage.rst
@@ -4,6 +4,12 @@
     eProsima Fast DDS Documentation
   </h1>
 
+.. TODO(eduponz): Remove this before releasing v3.0.0
+.. warning::
+
+    In preparation for v3.0.0, Fast DDS' master branch is undergoing major changes entailing **API breaks**.
+    Until Fast DDS v3.0.0 is released, it is strongly advisable to use the latest stable version, `2.14 <https://fast-dds.docs.eprosima.com/en/v2.14.0>`_.
+
 .. image:: /01-figures/logo.png
   :height: 100px
   :width: 100px