Skip to content

Commit

Permalink
Add missing documentation and PR template (#53)
Browse files Browse the repository at this point in the history
* Refs #20255: Document actions added for 0.7.0

Signed-off-by: EduPonz <[email protected]>

* Refs #20255: Add PR template

Signed-off-by: EduPonz <[email protected]>

* Refs #20255: Update versions.md

Signed-off-by: EduPonz <[email protected]>

* Refs #20255: Apply José's suggestions

Signed-off-by: EduPonz <[email protected]>

---------

Signed-off-by: EduPonz <[email protected]>
  • Loading branch information
EduPonz authored Jan 17, 2024
1 parent ab1b5ac commit 80635c2
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 1 deletion.
22 changes: 22 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!--
Provide a general summary of your changes in the Title above
It must be meaningful and coherent with the changes
If this PR is still a Work in Progress [WIP], please open it as DRAFT.
-->

## Description

<!--
Describe changes in detail.
This includes depicting the context, use case or current behavior and describe the proposed changes.
If several features/bug fixes are included with these changes, please consider opening separated pull requests.
-->

## Contributor Checklist
- [ ] Commit messages follow the company guidelines. <!-- External contributors should sign the DCO. Fast DDS developers must also refer to the internal Redmine task. -->
- [ ] Changes are API compatible. <!-- Public API must not be broken within the same major release. -->
- [ ] New features have been added to the `versions.md` and `README.md` files (if applicable).

## Reviewer Checklist
- [ ] The title and description correctly express the PR's purpose.
- [ ] The Contributor checklist is correctly filled.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,8 @@ For more information about versioning handle of this project, check following [f
- [set_platform](ubuntu/set_platform/action.yml)
- Set the platform OS version in a environment variable.

- [setup_cmake](ubuntu/setup_cmake/action.yml)
- Set a specific CMake version
---

## Workflows
Expand Down Expand Up @@ -260,3 +262,4 @@ Find below the external actions listed:
| [test-reporter](external/test-reporter/action.yml) | Display test results directly in GitHub | MIT license |
| [upload-artifact](external/upload-artifact/action.yml) | Upload build artifact | MIT license |
| [wait-on-check-action](external/wait-on-check-action/action.yml) | Wait on certain check | MIT license |
| [test-reporter](external/test-reporter/action.yml) | Generate test reports in workflow summaries | MIT license |
35 changes: 34 additions & 1 deletion versions.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,45 @@
# eProsima-CI Versions

This file includes the released versions of **eProsima-CI** along with their contributions to the project.
The *Forthcoming* section includes those features added in `main` branch that are not yet in a stable release.
The [Forthcoming](#forthcoming) section includes those features added in `main` branch that are not yet in a stable release.

- [Forthcoming](#forthcoming)
- [v0.7.0](#v0.7.0)
- [v0.6.0](#v0.6.0)
- [v0.5.0](#v0.5.0)
- [v0.4.0](#v0.4.0)
- [v0.4.0](#v0.4.0)
- [v0.3.0](#v0.3.0)
- [v0.2.0](#v0.2.0)

## Forthcoming

The upcoming release will include the following **features**:

## v0.7.0

This release includes the following **features**:

- Add `test-reporter` action
- Add `setup_cmake` action

## v0.6.0

This release includes the following **features**:

- Download eProsima dev-utils (`fetch_dev_utils_manual` action)
- Download eProsima ddspipe (`fetch_ddspipe_manual` action)
- Download eProsima Fast DDS (`fetch_fastdds_manual` action)
- New external action: download artifacts

## v0.5.0

This release includes the following **features**:

- Setup CCache.
- Install specific CMake and Ninja versions.
- Install and setup Python.

## v0.4.0

This release includes the following **features**:
Expand Down

0 comments on commit 80635c2

Please sign in to comment.