Alberto Pianon authored 2 years ago and Stefan Schmidt committed 2 years ago

Signed-off-by: Alberto Pianon <alberto@pianon.eu>

Marta Rybczynska authored 2 years ago and Andrei Gherzan committed 2 years ago

Update with hardening for 2.0, including sysctls and YP/OE
configuration. Some formatting updates in other places.

Signed-off-by: Marta Rybczynska <marta.rybczynska@linaro.org>

Zygmunt Krynicki authored 2 years ago and Kareem Zarka committed 2 years ago

Add documentation and notes on the OTA stack.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>
Signed-off-by: Kareem Zarka <kareem.zarka@huawei.com>
Signed-off-by: Zygmunt Krynicki <me@zygoon.pl>

Add the ledge doc from the oniro repo.

Signed-off-by: Marta Rybczynska <marta.rybczynska@linaro.org>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Reference the recently added document in the oniro repo.

Signed-off-by: Marta Rybczynska <marta.rybczynska@linaro.org>

Update the policy with details related to Eclipse processes,
the setup of the Gitlab bugtracker.

Signed-off-by: Marta Rybczynska <marta.rybczynska@linaro.org>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

The lua script for filtering out toctrees started to fail with the
latest pandoc with:

./CONTRIBUTING.lua:12: attempt to index a nil value (field 'integer
index')

We fix it by using the classes:includes which is simpler and it works.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Add docs of the update tool.

Signed-off-by: Marta Rybczynska <marta.rybczynska@linaro.org>

The Avenger board was already deprecated and this clean-ups some
remaining references in the ci docs..

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

The actual documentation was added in the Oniro repo. The new file need
to be added here as well to produce a working documentation build.

Signed-off-by: Stefan Schmidt <stefan.schmidt@huawei.com>

Relate-to: oniro!331 (comment 1025298)


Signed-off-by: Philippe Coval <philippe.coval.ext@huawei.com>

When the fork of the "docs" repository is called something else, we need to
refer to it by the real name to successfully perform the replacement for merge
request pipelines.

Use some bash and CI_MERGE_REQUEST_SOURCE_PROJECT_PATH to find the bare name of
the project. This works because the variable is re-interpolated by bash during
job execution.

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

Local manifests are mostly useful for various kinds of pipelines, e.g. for
merge requests and branch testing. They can use rules:if syntax to modify a
variable that is later used in shell. Due to the way variable interpolation
works in GitLab runners, the value itself cannot use further shell constructs,
like sub-shell substitution.

Introduce CI_ONIRO_REPO_WORKSPACE_LOCAL_MANIFEST_INTERPRETER variable, which
defaults to "echo" and allows using a custom interpreter. One possible use-case
is to use "eval" as interpreter and an arbitrary bash program, which is meant
to print the new local manifest, as value.

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

Grzegorz Gwóźdź authored 2 years ago and Grzegorz Gwóźdź committed 2 years ago

Add documentation file which describes onboarding process in the Oniro Project

Signed-off-by: Grzegorz Gwóźdź <grzegorz.gwozdz@huawei.com>

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

The IP policy included in the manifest is not applicable anymore for the
project under EF.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Hash-or-pound comments are valid for both YAML and bash. Adjust all the
comments that used bash-level nesting by accident back to YAML-level.

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

Working with the new documentation CI pipeline has uncovered problems caused by
attempts to cache the entire repo workspace. Initially there are no problems
but as pipelines are testing subsequent iterations of a branch, history may
become non-linear. In one case repo refused to synchronize (with repo sync
--force) the updated repository citing lack of common history.

In the experimental Oniro pipeline I've since switched to keeping a cache of
the git repo mirror, not repo workspace. This also helps with cache hit when
multiple releases are being tested, as cache is mostly static (per release) and
subsequent pipelines do not fight with each other by overwriting the cache to
their preferred state.

Some variable names are updated to better reflect what is going on. Ample new
documentation is added, as code comments, to explain how things work.

Note that some of the defaults are unexpected, as they are coming from the
oniro.git pipeline, and eventually will be included. This can be seen as
variables defined on the .oniro-repo-workspace job that are subsequently
re-defined in the build job.

In addition, add explicit cleanup to counteract GIT_STRATEGY=none.

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

Eclipse security bugracker has been created, so use it now.

Signed-off-by: Marta Rybczynska <marta.rybczynska@huawei.com>

Relate-to: oniro#787
Relate-to: https://git.ostc-eu.org/oss-compliance/ip-policy/-/issues/18
Relate-to: oniro!311
Forwarded: !20


Signed-off-by: Philippe Coval <philippe.coval.ext@huawei.com>

The .oniro-repo-workspace job uses GIT_STRATEGY=none, so CI_PROJECT_DIR
is not cleaned up between jobs. As a consequence, the "aggregated"
repository checkout may be present on job startup, thus upsetting
remaining logic.

Remvoe the aggregated repository before starting the build.

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

This should avoid the problem of ECA check.

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

The docs builder uses root as the primary user of the container,
therefore should alleviate cache ownership issues.

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

Some images use a non-root user. Having access to this information in
the logs may help debug issues related to file owneship of cache
elements.

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

The documentation repository relies on a series of symbolic links that
connect it to the oniro.git repository, when used inside a checked-out
repo workspace.

Ever since we switched to the symlink-based override that supports
branch selection for merge requests and merge trains, the docs
repository stopped to build correctly.

This is caused by now-broken symbolic links that once traversed, no
longer point to the files in oniro.git, due to the way the redirection
code works.

An entirely new pipeline was created to avoid this problem, and to unify
other repo-hacking systems that we introduced over time. A prototype of
this new pipeline is now available here, in the docs repository.

The main difference is that local manifests are now used to edit the
repo composition before "repo sync" is used. This allows us to achieve
the same effect we had before, but using first-party systems. The
secondary difference is that the docs pipeline is now separated from
changes (including breaking changes) in the oniro.git pipeline.

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

ModBUS documentation is included from oniro.git index but that index is
explicitly excluded here. Include it again from the local index for
documentation to build correctly.

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

Signed-off-by: Grzegorz Gwozdz <grzegorz.gwozdz@huawei.com>

`oniro` introduced support and the associated documentation for
containers. Pull it into the aggregated Oniro docs.

Fixes: #157



Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

This is coming from the oniro repository but the TOC is redefined in
docs leaving that document dangling.

This also fixes a build warning treated as an error:

Warning, treated as error:
[...]/docs/oniro/debug-mode.rst:document isn't included in any toctree
make: *** [Makefile:16: build] Error

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Signed-off-by: Esben Haabendal <esben.haabendal@huawei.com>

Signed-off-by: Esben Haabendal <esben.haabendal@huawei.com>

Signed-off-by: Pavel Zhukov <pavel.zhukov@huawei.com>

The container image already defines the user and the email for the
builder's/CI's git operations[1] so there is no need to override it here
and have to maintain two places for this identity.

[1]https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/blob/kirkstone/.oniro-ci/containers/bitbake-builder/Dockerfile

Fixes oniro#513



Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>