Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document platform support tiers for all collections #215

Merged
merged 11 commits into from
Dec 23, 2021
Merged

Document platform support tiers for all collections #215

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
7a3f274
Documnent support tiers for all collections
chapulina Nov 13, 2021
44b2339
Buster
chapulina Nov 13, 2021
99af6dc
Fortress on Jammy
chapulina Nov 13, 2021
abbb9d9
cleanup
chapulina Nov 13, 2021
3e2f349
Table
chapulina Nov 15, 2021
f24e3ae
tables
chapulina Nov 15, 2021
b50c6d6
not supported PRs
chapulina Nov 15, 2021
805049d
oops
chapulina Nov 15, 2021
958f6c6
PR feedback
chapulina Nov 22, 2021
6fdd664
Catalina and BigSur
chapulina Dec 20, 2021
ec6a7f4
Move best-effort status to tickets
chapulina Dec 20, 2021
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
41 changes: 27 additions & 14 deletions citadel/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,6 @@
# Citadel Installation

Citadel supports the following platforms:

* Ubuntu Bionic on amd64/i386 and Focal on amd64
* MacOS Mojave
* Ignition currently only works in headless mode
(GUI does not render; instead of using `ign gazebo fuel.sdf` command, use
`ign gazebo -s fuel.sdf` to start the server only).
* Windows 10
* Ignition command line utilities are not yet supported.
* All packages up to but not including `ign-gazebo` are currently building.
* DART physics engine is not yet supported.
* Qt (GUI functionality) is not yet supported.
# Ignition Citadel

Ignition Citadel is the 3rd major release of Ignition, and its 1st 5-year-LTS.

## Binary installation instructions

Expand Down Expand Up @@ -52,3 +40,28 @@ collection assures that all libraries are compatible and can be used together.
| ign-tools | 1.x |
| ign-transport | 8.x |
| sdformat | 9.x |

## Supported platforms

Citadel is [supported](/docs/all/releases) on the platforms below.

These are the officially supported platforms:
chapulina marked this conversation as resolved.
Show resolved Hide resolved

* Ubuntu Bionic on amd64/i386
* Ubuntu Focal on amd64

All other platforms on the table are supported at best-effort.

Operating System | Architecture | Packaging | CI | Functionality
---------------- | ------------ | --------- | -- | -------------
Ubuntu Bionic | amd64 | ✅ Yes | ✅ Yes, every pull request | ✅ All
j-rivero marked this conversation as resolved.
Show resolved Hide resolved
. | i386 | ✅ Yes | No | ✅ All
. | arm64 | ❓ Maybe | No | Most low-level libraries known to work
. | armhf | ❓ Maybe | No | Most low-level libraries known to work, DART physics engine not available
Ubuntu Focal | amd64 | ✅ Yes | ✅ Yes, every pull request | ✅ All
. | arm64 | ❓ Maybe | No | Most low-level libraries known to work
. | armhf | ❓ Maybe | No | Most low-level libraries known to work, DART physics engine not available
Debian Buster | amd64, i386, arm64, armhf | ❓ Maybe | No | Several libraries known to work
MacOS Mojave | - | ✅ Yes | ✅ Yes, every pull request | Ignition only works in headless mode (GUI does not render; instead of using `ign gazebo fuel.sdf` command, use `ign gazebo -s fuel.sdf` to start the server only).
chapulina marked this conversation as resolved.
Show resolved Hide resolved
Windows 10 | . | ❓ Maybe | Some libraries tested on every pull request | Command line utilities are not supported. All packages up to but not including `ign-gazebo` are currently building. DART physics engine is not supported. Qt (GUI functionality) is not supported.

41 changes: 27 additions & 14 deletions dome/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,6 @@
# Dome Installation

Dome supports the following platforms:

* Ubuntu Bionic amd64/arm64/i386 and Focal on amd64/arm64
* MacOS Mojave and Catalina
* Ignition currently only works in headless mode
(GUI does not render; instead of using `ign gazebo fuel.sdf` command, use
`ign gazebo -s fuel.sdf` to start the server only).
* Windows 10
* Ignition command line utilities are not yet supported.
* All packages up to but not including `ign-gazebo` are currently building.
* DART physics engine is not yet supported.
* Qt (GUI functionality) is not yet supported.
# Ignition Dome

Ignition Dome is the 4th major release of Ignition. It's a short-term support.

## Binary installation instructions

Expand Down Expand Up @@ -52,3 +40,28 @@ collection assures that all libraries are compatible and can be used together.
| ign-tools | 1.x |
| ign-transport | 9.x |
| sdformat | 10.x |

## Supported platforms

Dome is [supported](/docs/all/releases) on the platforms below.

These are the officially supported platforms:

* Ubuntu Bionic on amd64/i386
* Ubuntu Focal on amd64

All other platforms on the table are supported at best-effort.

j-rivero marked this conversation as resolved.
Show resolved Hide resolved
Operating System | Architecture | Packaging | CI | Functionality
---------------- | ------------ | --------- | -- | -------------
Ubuntu Bionic | amd64 | ✅ Yes | ✅ Yes, every pull request | ✅ All
. | i386 | ✅ Yes | No | ✅ All
. | arm64 | ❓ Maybe | No | Most low-level libraries known to work
. | armhf | ❓ Maybe | No | Most low-level libraries known to work, DART physics engine not available
Ubuntu Focal | amd64 | ✅ Yes | ✅ Yes, every pull request | ✅ All
. | arm64 | ❓ Maybe | No | Most low-level libraries known to work
. | armhf | ❓ Maybe | No | Most low-level libraries known to work, DART physics engine not available
Debian Buster | amd64, i386, arm64, armhf | ❓ Maybe | No | Several libraries known to work
MacOS Mojave and Catalina | - | ✅ Yes | ✅ Yes, every pull request (TODO: which version?) | Ignition only works in headless mode (GUI does not render; instead of using `ign gazebo fuel.sdf` command, use `ign gazebo -s fuel.sdf` to start the server only).
Windows 10 | . | ❓ Maybe | Some libraries tested on every pull request | Command line utilities are not supported. All packages up to but not including `ign-gazebo` are currently building. DART physics engine is not supported. Qt (GUI functionality) is not supported.

41 changes: 27 additions & 14 deletions edifice/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,6 @@
# Edifice Installation

Edifice supports the following platforms:

* Ubuntu Bionic amd64/arm64/i386 and Focal on amd64/arm64
* MacOS Mojave and Catalina
* Ignition currently only works in headless mode
(GUI does not render; instead of using `ign gazebo fuel.sdf` command, use
`ign gazebo -s fuel.sdf` to start the server only).
* Windows 10
* Ignition command line utilities are not yet supported.
* All packages up to but not including `ign-gazebo` are currently building.
* DART physics engine is not yet supported.
* Qt (GUI functionality) is not yet supported.
# Ignition Edifice

Ignition Edifice is the 5th major release of Ignition. It's a short-term support.

## Binary installation instructions

Expand Down Expand Up @@ -53,3 +41,28 @@ collection assures that all libraries are compatible and can be used together.
| ign-transport | 10.x |
| ign-utils | 1.x |
| sdformat | 11.x |

## Supported platforms

Edifice is [supported](/docs/all/releases) on the platforms below.

These are the officially supported platforms:

* Ubuntu Bionic on amd64/i386
* Ubuntu Focal on amd64

All other platforms on the table are supported at best-effort.

Operating System | Architecture | Packaging | CI | Functionality
---------------- | ------------ | --------- | -- | -------------
Ubuntu Bionic | amd64 | ✅ Yes | ✅ Yes, every pull request | ✅ All
. | i386 | ✅ Yes | No | ✅ All
. | arm64 | ❓ Maybe | No | Most low-level libraries known to work
. | armhf | ❓ Maybe | No | Most low-level libraries known to work, DART physics engine not available
Ubuntu Focal | amd64 | ✅ Yes | ✅ Yes, every pull request | ✅ All
. | arm64 | ❓ Maybe | No | Most low-level libraries known to work
. | armhf | ❓ Maybe | No | Most low-level libraries known to work, DART physics engine not available
Debian Buster | amd64, i386, arm64, armhf | ❓ Maybe | No | Several libraries known to work
MacOS Mojave and Catalina | - | ✅ Yes | ✅ Yes, every pull request (TODO: which version?) | Ignition only works in headless mode (GUI does not render; instead of using `ign gazebo fuel.sdf` command, use `ign gazebo -s fuel.sdf` to start the server only).
Windows 10 | . | ❓ Maybe | ✅ Yes, every pull request | Command line utilities are not supported. All packages up to but not including `ign-gazebo` are currently building. DART physics engine is not supported. Qt (GUI functionality) is not supported.

42 changes: 29 additions & 13 deletions fortress/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,6 @@
# Fortress Installation
# Ignition Fortress

Fortress supports the following platforms:

* Ubuntu Bionic amd64/arm64/i386 and Focal on amd64/arm64
* MacOS Catalina and BigSur
* Ignition currently only works in headless mode using Ogre 1
(GUI does not render; instead of using `ign gazebo fuel.sdf` command, use
`ign gazebo -s fuel.sdf` to start the server only).
* Windows 10
* Ignition command line utilities are not yet supported.
* All packages up to `ign-gazebo` can be built.
* DART physics engine is not yet supported.
* Qt (GUI functionality) is not yet supported.
Ignition Fortress is the 6th major release of Ignition, and its 2nd 5-year LTS.

## Binary installation instructions

Expand Down Expand Up @@ -59,3 +48,30 @@ collection assures that all libraries are compatible and can be used together.
| ign-transport | 11.x |
| ign-utils | 1.x |
| sdformat | 12.x |

## Supported platforms

Fortress is [supported](/docs/all/releases) on the platforms below.

These are the officially supported platforms:

* Ubuntu Bionic on amd64/i386
* Ubuntu Focal on amd64
* (Ubuntu Jammy on amd64 once that's released)

All other platforms on the table are supported at best-effort.

Operating System | Architecture | Packaging | CI | Functionality
---------------- | ------------ | --------- | -- | -------------
Ubuntu Bionic | amd64 | ✅ Yes | ✅ Yes, every pull request | ✅ All
. | i386 | ✅ Yes | No | ✅ All
. | arm64 | ❓ Maybe | No | Most low-level libraries known to work
. | armhf | ❓ Maybe | No | Most low-level libraries known to work, DART physics engine not available
Ubuntu Focal | amd64 | ✅ Yes | ✅ Yes, every pull request | ✅ All
. | arm64 | ❓ Maybe | No | Most low-level libraries known to work
. | armhf | ❓ Maybe | No | Most low-level libraries known to work, DART physics engine not available
Ubuntu Jammy | amd64, i386, arm64, armhf | TODO | TODO | TODO
Debian Buster | amd64, i386, arm64, armhf | ❓ Maybe | No | Several libraries known to work
MacOS Catalina and BigSur | - | ✅ Yes | ✅ Yes, every pull request (TODO: which version?) | Ignition only works in headless mode using Ogre 1 (GUI does not render; instead of using `ign gazebo fuel.sdf` command, use `ign gazebo -s fuel.sdf` to start the server only).
Windows 10 | . | ❓ Maybe | ✅ Yes, every pull request | Command line utilities are not supported. All packages up to but not including `ign-gazebo` are currently building. DART physics engine is not supported. Qt (GUI functionality) is not supported.

43 changes: 27 additions & 16 deletions garden/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,9 @@
# Garden Installation
# Ignition Garden

Up to Garden's release date, the collection should be considered unstable.

For the moment, Garden supports the following platforms:

* Ubuntu Bionic amd64/arm64/i386 and Focal on amd64/arm64
* MacOS Catalina and BigSur
* Ignition currently only works in headless mode using Ogre 1
(GUI does not render; instead of using `ign gazebo fuel.sdf` command, use
`ign gazebo -s fuel.sdf` to start the server only).
* Windows 10
* Ignition command line utilities are not yet supported.
* All packages up to `ign-gazebo` can be built.
* DART physics engine is not yet supported.
* Qt (GUI functionality) is not yet supported.
Ignition Garden will be the 7th major release of Ignition. It will be a
short-term release.

The supported platforms may change up to the release date.
Up to Garden's release date, the collection should be considered unstable.

## Binary installation instructions

Expand Down Expand Up @@ -54,3 +42,26 @@ This list of library versions may change up to the release date.
| ign-transport | 11.x |
| ign-utils | 1.x |
| sdformat | 12.x |

## Supported platforms

Garden is planned to be [supported](/docs/all/releases) on the platforms below.
This list may change up to the release date.

These are the officially supported platforms:

* Ubuntu Focal on amd64
* Ubuntu Jammy on amd64

All other platforms on the table are supported at best-effort.

Operating System | Architecture | Packaging | CI | Functionality
---------------- | ------------ | --------- | -- | -------------
Ubuntu Focal | amd64 | ✅ Yes | ✅ Yes, every pull request | ✅ All
. | arm64 | ❓ Maybe | No | Most low-level libraries known to work
. | armhf | ❓ Maybe | No | Most low-level libraries known to work, DART physics engine not available
Ubuntu Jammy | amd64, i386, arm64, armhf | TODO | TODO | TODO
Debian Buster | amd64, i386, arm64, armhf | ❓ Maybe | No | Several libraries known to work
MacOS Catalina and BigSur | - | ✅ Yes | ✅ Yes, every pull request (TODO: which version?) | Ignition only works in headless mode using Ogre 1 (GUI does not render; instead of using `ign gazebo fuel.sdf` command, use `ign gazebo -s fuel.sdf` to start the server only).
Windows 10 | . | ❓ Maybe | ✅ Yes, every pull request | Command line utilities are not supported. All packages up to but not including `ign-gazebo` are currently building. DART physics engine is not supported. Qt (GUI functionality) is not supported.

4 changes: 2 additions & 2 deletions index.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ pages:
- name: release
title: Release process
file: release.md
description: Release process overview
description: Release process overview.
unlisted: true
- name: ci
title: Continuous Integration
file: ci.md
description: Continuous Integration overview
description: Continuous Integration overview.
unlisted: true
releases:
- name: garden
Expand Down
31 changes: 31 additions & 0 deletions releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,34 @@ Ign-(N+2) | void bar();

Check out [this table](https://github.com/ignitionrobotics/docs/blob/master/tools/versions.md)
for a list of release and EOL dates for all versions of all libraries.

### Supported platforms
chapulina marked this conversation as resolved.
Show resolved Hide resolved

Platforms are defined as a combination of operating system and architecture.
For example, "Ubuntu Focal on amd64".

Each release is targeted at a specific set of platforms. A support level applies
to an entire Ignition release, including all library versions within it. The
supported platforms for each release are listed on their home pages (i.e.
[Fortress](https://ignitionrobotics.org/docs/fortress)).

In general, there are three categories of support for a platform:

* **Official support**: Officially supported platforms are regularly tested on
continuous integration and released as binary packages. Errors or bugs
discovered in these platforms are prioritized for correction by the
development team. Significant errors discovered in these platforms can impact
release dates and we strive to resolve all known high priority errors in
officially supported platforms prior to new version releases.
* **Best-effort support**: Platforms supported at best-effort may be regularly
tested on continuous integration and / or released as binary packages. Errors
may be present in released versions for these platforms. Known errors in
best-effort platforms will be addressed subject to resource availability on a
best-effort basis and may or may not be corrected prior to new releases.
* **Not supported**: All platforms not included under official or best-effort
chapulina marked this conversation as resolved.
Show resolved Hide resolved
support are considered not supported. If a release is functional in a not
supported platform at a point in time, there are no guarantees that it will
remain in the future. Pull requests addressing issues on not supported
platforms may be considered if they don't break any supported platforms and
reviewed as time allows.

j-rivero marked this conversation as resolved.
Show resolved Hide resolved