The API coverage documentation support was (relatively) recently introduced
in bad87f1684 and is not available in older
release branches.
Since doc-publish workflows always run in the default (main) branch
context, it is necessary to make the API coverage documentation handling
optional for the workflow runs that are triggered from older release
branches.
Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
This commit updates the CI workflows to use the `zephyrproject-rtos`
organisation-level AWS secrets instead of the repository-level secrets.
Using organisation-level secrets allows more centralised management of
the access keys used throughout the GitHub Actions CI infrastructure.
Note that the `AWS_*_ACCESS_KEY_ID` is now stored in plaintext as a
variable instead of a secret because it is equivalent to username and
needs to be identifiable for management and audit purposes.
Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
This commit updates the CI workflows to use the AWS
configure-aws-credentials action v2, which is based on node.js 16 and
@actions/core 1.10.0, in preparation for the upcoming removal of the
deprecated GitHub features.
Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
Use the latest Ubuntu image. There's no special reason for this change
other than staying up-to-date.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit updates the documentation build and publish workflows to
use a specific runner image version, ubuntu-20.04, instead of the
latest version in order to prevent any potential breakages due to the
'latest' version change by GitHub.
Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
GitHub Actions may trigger the `workflow_run` event type when the
pull request source branch name matches one of the branches specified
under `branches:`.
This commit updates the documentation publish workflow to skip when the
preceding event type is `pull_request`, in order to prevent pull
request documentation from being uploaded as main documentation.
Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
This commit updates the CI documentation build workflow to upload the
HTML pull request documentation builds to the S3 builds.zephyrproject.io
bucket so that they are directly accessible from the web.
Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
Set the artifact run_id to the one from the doc-build workflow. This way
the downloaded artifact should always match the one from the build
action that triggered publish.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
To restrict the job to the upstream repository a new `if` entry was
added, however, another `if` was already present (violates yaml).
Combined the conditions into a single expression.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This reverts commit 40a5cf6016. Debug
information is no longer necessary as doc-publish workflow is now
working correctly.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Enable debug mode and disable quiet option. It should help diagnosing
AWS S3 problems. Some prints have also been added to spot potential
problems.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
`github.event.workflow_run.head_branch` contains the actual release tag
on releases, so it is required. It does not affect the publication of
"latest".
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Publish action has been refactored into a workflow_run based action.
The action is now triggered after a successful doc-build workflow run
(only on main/release branches). The artifacts are downloaded from the
build run and published accordingly. Publish code has been simplified a
bit and PDF upload has been added.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Publish docs every 3 hours, this way fixes early in the morning are
reflected online earlier and no need to wait until the next day.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
`check-warns` step is no longer used since the introduction of
`warnings_filter` extension.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Upgrade core Python dependencies (setuptools, wheel, pip) at a system
level. Some old versions of pip do not resolve the dependency chain
correctly, this is why it has been added to the list.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Move the top-level Makefile to the documentation folder as it is only
used for documentation.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
When VERSION is changed, do not wait for daily cron and publish
documentation immediately to keep things in sync.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
We have been publishing docs to the wrong folter on AWS S3. We still had
the official docs published to the correct place manually though, so all
was good.
This change will eliminate the manual step of publishing documentation
and will put things where they belong.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Use descriptive and unique job names, otherwise we end up with those
showing up in different location with no way to know which is which.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Currently, nightly releases are performed in Forks as well.
Since these fail due to missing AWS credentials this causes
a lot of messages about failing builds, this commit disables
them for Forks.
Signed-off-by: Max Bachmann <kontakt@maxbachmann.de>
Github has deprecated add-path, so update the workflows that use it to
the new method of setting the PATH.
Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
breathe v4.15.0 was just released and fixes some compatibility issues
with latest sphinx, the combo works, however with many warnings that we
still need to either fix or whitelist. This is temporary until we are
able to use those new versions.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Now that we found the permission issue that was causing the aws s3 sync
to fail we can remove the debug flag.
Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
This branch filter doesn't work as expected with tag. Need to test this
more on testing tree to find a combo or solution that works properly.
Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
For some reason the aws s3 sync fails, but not sure exactly why. Adding
more debug to see if we can understand what's going on.
Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
Limit doc publish workflow to master branch. Need to see if we can
seperate out 'latest' to be on master only and release branches to
publish to the proper location.
Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
The doc publish workflow is failing in the AWS S3 push. Add more
debug output in that section to see what's going on.
Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
We now need pyelftools to build the docs. See the following commit:
commit 83b346edef
Author: Alexey Brodkin <abrodkin@synopsys.com>
Date: Fri Feb 7 11:37:25 2020 +0300
runners: opeocd: Allow loading Elf-files
Match the update to doc-build.yml to `pip3 install pyelftools`.
Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
