Skip to content

Commit a783abc

Browse files
committed
Prepare 3.0.x-devel to become master (#750)
* Refs #20893: Add warning to intro page Signed-off-by: eduponz <[email protected]> * Refs #20893: Update PR template Signed-off-by: eduponz <[email protected]> * Refs #20893: Warning in README Signed-off-by: eduponz <[email protected]> * Refs #20893: Update mirror workflow Signed-off-by: eduponz <[email protected]> * Refs #20893: Apply Eliana's suggestions Signed-off-by: eduponz <[email protected]> --------- Signed-off-by: eduponz <[email protected]>
1 parent 7fd5e1c commit a783abc

File tree

4 files changed

+39
-2
lines changed

4 files changed

+39
-2
lines changed

.github/pull_request_template.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
In case of bug fixes, please provide the list of supported branches where this fix should be also merged.
2020
Please uncomment following line, adjusting the corresponding target branches for the backport.
2121
-->
22-
<!-- @Mergifyio backport 2.13.x 2.10.x 2.6.x -->
22+
<!-- @Mergifyio backport 2.14.x 2.13.x 2.10.x 2.6.x -->
2323

2424
<!-- If an issue is already opened, please uncomment next line with the corresponding issue number. -->
2525
<!-- Fixes #(issue) -->
@@ -35,6 +35,11 @@ Related implementation PR:
3535

3636
## Contributor Checklist
3737

38+
<!--
39+
- If any of the elements of the following checklist is not applicable, substitute the checkbox [ ] by _N/A_:
40+
- 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__:.
41+
-->
42+
3843
- [ ] Commit messages follow the project guidelines. <!-- External contributors should sign the DCO. Fast DDS docs developers must also refer to the internal Redmine task. -->
3944
- [ ] Code snippets related to the added documentation have been provided.
4045
- [ ] Documentation tests pass locally.

.github/workflows/mirror.yml

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,19 @@ on:
33
push:
44
branches:
55
- 'master'
6+
- '2.14.x'
67

78
jobs:
8-
mirror_job:
9+
mirror_job_master:
10+
if: github.ref == 'refs/heads/master'
911
name: Mirror master branch to latest minor branches
1012
runs-on: ubuntu-latest
1113
strategy:
1214
fail-fast: false
1315
matrix:
1416
dest_branch:
1517
- '3.0.x'
18+
- '3.x'
1619
steps:
1720
- name: Mirror action step
1821
id: mirror
@@ -21,3 +24,21 @@ jobs:
2124
github-token: ${{ secrets.GITHUB_TOKEN }}
2225
source: 'master'
2326
dest: ${{ matrix.dest_branch }}
27+
28+
mirror_job_2_x:
29+
if: github.ref == 'refs/heads/2.14.x'
30+
name: Mirror 2.14.x branch to latest minor branches
31+
runs-on: ubuntu-latest
32+
strategy:
33+
fail-fast: false
34+
matrix:
35+
dest_branch:
36+
- '2.x'
37+
steps:
38+
- name: Mirror action step
39+
id: mirror
40+
uses: eProsima/eProsima-CI/external/mirror-branch-action@main
41+
with:
42+
github-token: ${{ secrets.GITHUB_TOKEN }}
43+
source: '2.14.x'
44+
dest: ${{ matrix.dest_branch }}

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
55
[![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/)
66

7+
<!-- TODO(eduponz): Remove this before releasing v3.0.0 -->
8+
> [!WARNING]
9+
> **In preparation for v3.0.0, Fast DDS' master branch is undergoing major changes entailing API breaks.**
10+
> **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).**
11+
712
<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>
813

914
*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,

docs/02-formalia/titlepage.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
eProsima Fast DDS Documentation
55
</h1>
66

7+
.. TODO(eduponz): Remove this before releasing v3.0.0
8+
.. warning::
9+
10+
In preparation for v3.0.0, Fast DDS' master branch is undergoing major changes entailing **API breaks**.
11+
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.1>`_.
12+
713
.. image:: /01-figures/logo.png
814
:height: 100px
915
:width: 100px

0 commit comments

Comments
 (0)