From 3fbf8f14da86d6ec0423bf7218058797dde9ac53 Mon Sep 17 00:00:00 2001 From: Eduardo Ponz Segrelles Date: Thu, 9 May 2024 10:17:47 +0200 Subject: [PATCH] Prepare 3.0.x-devel to become master (#750) * Refs #20893: Add warning to intro page Signed-off-by: eduponz * Refs #20893: Update PR template Signed-off-by: eduponz * Refs #20893: Warning in README Signed-off-by: eduponz * Refs #20893: Update mirror workflow Signed-off-by: eduponz * Refs #20893: Apply Eliana's suggestions Signed-off-by: eduponz --------- Signed-off-by: eduponz --- .github/pull_request_template.md | 7 ++++++- .github/workflows/mirror.yml | 23 ++++++++++++++++++++++- README.md | 5 +++++ docs/02-formalia/titlepage.rst | 6 ++++++ 4 files changed, 39 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 42d9d076d..499d96574 100644 --- 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. --> - + @@ -35,6 +35,11 @@ Related implementation PR: ## Contributor Checklist + + - [ ] Commit messages follow the project guidelines. - [ ] 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 index 551e02686..436752a65 100644 --- a/.github/workflows/mirror.yml +++ b/.github/workflows/mirror.yml @@ -3,9 +3,11 @@ 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: @@ -13,6 +15,7 @@ jobs: 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 index 765e8bbf3..62de66679 100644 --- 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/) + +> [!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).** + *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 index cbda89103..69ff78ec9 100644 --- a/docs/02-formalia/titlepage.rst +++ b/docs/02-formalia/titlepage.rst @@ -4,6 +4,12 @@ eProsima Fast DDS Documentation +.. 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 `_. + .. image:: /01-figures/logo.png :height: 100px :width: 100px