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.

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

Sync with docker acap #63

Merged
merged 16 commits into from
Mar 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
build-*
tmp
.vscode
6 changes: 3 additions & 3 deletions .github/actions/docker-build-action/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,12 @@ runs:
using: composite
steps:
- name: Set up Docker buildx
uses: docker/setup-buildx-action@v2
uses: docker/setup-buildx-action@v3
- name: Set up QEMU
if: ${{ inputs.use_qemu == 'true'}}
uses: docker/setup-qemu-action@v2
uses: docker/setup-qemu-action@v3
- name: Build image
uses: docker/build-push-action@v4
uses: docker/build-push-action@v5
with:
context: .
push: false
Expand Down
2 changes: 1 addition & 1 deletion .github/actions/metadata-action/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ runs:
steps:
- name: Create metadata for docker image
id: meta
uses: docker/metadata-action@v4
uses: docker/metadata-action@v5
with:
images: ${{ inputs.repository }}
# adds the suffix for all tags, even latest.
Expand Down
22 changes: 11 additions & 11 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,21 @@ name: Sign and prerelease
on:
push:
branches:
- 'main'
- "main"
tags:
# semver, e.g. 1.2.0 (does not match 0.1.2)
- '[1-9]+.[0-9]+.[0-9]+'
- "[1-9]+.[0-9]+.[0-9]+"
# semver with prerelease info, e.g. 1.0.2-beta.1 or 1.2.3-rc.10
- '[1-9]+.[0-9]+.[0-9]+-[a-z]+.[0-9]+'
- "[1-9]+.[0-9]+.[0-9]+-[a-z]+.[0-9]+"
# do not match prerelease starting w/ 0, e.g. 1.0.2-beta.0 or 1.2.3-rc.01
- '![1-9]+.[0-9]+.[0-9]+-[a-z]+.[0]*'
- "![1-9]+.[0-9]+.[0-9]+-[a-z]+.[0]*"
# semver with date info, e.g. 1.0.2-20221125
- '[1-9]+.[0-9]+.[0-9]+-[0-9]+'
- "[1-9]+.[0-9]+.[0-9]+-[0-9]+"
# do not match date starting w/ 0, e.g. 1.0.2-01232023
- '![1-9]+.[0-9]+.[0-9]+-[0]*'
- "![1-9]+.[0-9]+.[0-9]+-[0]*"
pull_request:
branches:
- 'main'
- "main"

jobs:
# Builds docker ACAP using the build.sh script, then signs the eap-file in
Expand All @@ -43,8 +43,8 @@ jobs:
uses: ./.github/actions/metadata-action
with:
suffix: -${{ matrix.arch }}
repository: 'docker-compose-acap'
get_version: 'true'
repository: "docker-compose-acap"
get_version: "true"
- name: Update manifest file
if: ( github.ref_type == 'tag')
uses: ./.github/actions/update-acap-manifest-action
Expand Down Expand Up @@ -91,7 +91,7 @@ jobs:
echo "HTTP_RESPONSE is empty or not a valid integer: $HTTP_RESPONSE"
fi
- name: Upload artifact
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: ${{ env.SIGNED_EAP_FILE }}
path: build/${{ env.SIGNED_EAP_FILE }}
Expand Down Expand Up @@ -123,7 +123,7 @@ jobs:
id: vars
run: echo "TAG=${GITHUB_REF#refs/*/}" >> ${GITHUB_ENV}
- name: Create prerelease
uses: actions/github-script@v6
uses: actions/github-script@v7
id: prerelease
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
fetch-depth: 0

- name: Lint codebase
uses: super-linter/super-linter/slim@v5
uses: super-linter/super-linter/slim@v6
env:
VALIDATE_ALL_CODEBASE: true
DEFAULT_BRANCH: main
Expand Down
7 changes: 7 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"recommendations": [
"DavidAnson.vscode-markdownlint",
"editorconfig.editorconfig",
"streetsidesoftware.code-spell-checker"
]
}
18 changes: 18 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"C_Cpp.clang_format_style": "file",
"[markdown]": {
"editor.defaultFormatter": "DavidAnson.vscode-markdownlint",
"editor.formatOnSave": true,
"editor.formatOnPaste": true
},
"markdown.extension.list.indentationSize": "inherit",
"markdown.extension.toc.levels": "1..3",
"cSpell.words": [
"anyauth",
"Buildx",
"containerd",
"dockerdwrapperwithcompose",
"rootpasswd",
"VAPIX"
]
}
232 changes: 232 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,232 @@
<!-- omit in toc -->
# Regarding contributions

All types of contributions are encouraged and valued. See the [Table of contents](#table-of-contents)
for different ways to help and details about how this project handles them. Please make sure to read
the relevant section before making your contribution. It will make it a lot easier for us maintainers
and smooth out the experience for all involved. We look forward to your contributions.

> And if you like the project, but just don't have time to contribute, that's fine. There are other
> easy ways to support the project and show your appreciation, which we would also be very happy about:
>
> - Star the project
> - Tweet about it
> - Refer this project in your project's readme
> - Mention the project at local meetups and tell your friends/colleagues

<!-- omit in toc -->
## Table of contents

- [I have a question](#i-have-a-question)
- [I want to contribute](#i-want-to-contribute)
- [Reporting bugs](#reporting-bugs)
- [Before submitting a bug report](#before-submitting-a-bug-report)
- [How do I submit a good bug report?](#how-do-i-submit-a-good-bug-report)
- [Suggesting enhancements](#suggesting-enhancements)
- [Before Submitting an Enhancement](#before-submitting-an-enhancement)
- [How do I submit a good enhancement suggestion?](#how-do-i-submit-a-good-enhancement-suggestion)
- [Your first code contribution](#your-first-code-contribution)
- [Lint of codebase](#lint-of-codebase)
- [Linters in GitHub Action](#linters-in-github-action)
- [Run super-linter locally](#run-super-linter-locally)
- [Run super-linter interactively](#run-super-linter-interactively)

## I have a question

Before you ask a question, it is best to search for existing [issues][issues] that might help you.
In case you have found a suitable issue and still need clarification, you can write your question in
this issue. It is also advisable to search the internet for answers first.
deepikas20 marked this conversation as resolved.
Show resolved Hide resolved
madelen-at-work marked this conversation as resolved.
Show resolved Hide resolved

If you then still feel the need to ask a question and need clarification, please
follow the steps in [Reporting bugs](#reporting-bugs).

## I want to contribute

### Reporting bugs

#### Before submitting a bug report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we
ask you to investigate carefully, collect information and describe the issue in detail in your report.
Please complete the following steps in advance to help us fix any potential bug as fast as possible:

- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment
components/versions.
- To see if other users have experienced (and potentially already solved) the same issue you are having,
check if there is not already a bug report existing for your bug or error in the [bug tracker][issues_bugs].
- Also make sure to search the internet to see if users outside of the GitHub community have discussed
the issue.
- Collect information about the bug:
- Axis device model
- Axis device firmware version
- Stack trace
- OS and version (Windows, Linux, macOS, x86, ARM)
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what
seems relevant
- Possibly your input and the output
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?

#### How do I submit a good bug report?

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

- Open an [issue][issues_new].
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the *reproduction steps* that someone else
can follow to recreate the issue on their own.
- Provide the information you collected in the previous section.

Once it's filed:

- The project team will label the issue accordingly.
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction
steps or no obvious way to reproduce the issue, the team will ask you for those steps. Bugs without
steps will not be addressed until they can be reproduced.
- If the team is able to reproduce the issue, it will be prioritized according to severity.

### Suggesting enhancements

This section guides you through submitting an enhancement suggestion,
**including completely new features and minor improvements to existing functionality**.
Following these guidelines will help maintainers and the community to understand your suggestion and
find related suggestions.

#### Before Submitting an Enhancement

- Make sure that you are using the latest version.
- Read the documentation carefully and find out if the functionality is already covered, maybe by an
individual configuration.
- Perform a [search][issues] to see if the enhancement has already been suggested. If it has, add a
comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. Keep in mind that we want
features that will be useful to the majority of our users and not just a small subset.

#### How do I submit a good enhancement suggestion?

Enhancement suggestions are tracked as [GitHub issues][issues].

- Use a **clear and descriptive title** for the issue to identify the suggestion.
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
At this point you can also tell which alternatives do not work for you.
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or
point out the part which the suggestion is related to.
- **Explain why this enhancement would be useful** to most users. You may also want to point out the
other projects that solved it better and which could serve as inspiration.

### Your first code contribution

Start by [forking the repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo),
i.e. copying the repository to your account to grant you write access. Continue with cloning the
forked repository to your local machine.

```sh
git clone https://github.com/<your username>/AxisCommunications/docker-compose-acap.git
```

Navigate into the cloned directory and create a new branch:

```sh
cd docker-compose-acap
git switch -c <branch name>
```

Update the code according to your requirements, and commit the changes using the
[conventional commits](https://www.conventionalcommits.org) message style:

```sh
git commit -a -m 'Follow the conventional commit messages style to write this message'
```

Continue with pushing the local commits to GitHub:

```sh
git push origin <branch name>
```

Before opening a Pull Request (PR), please consider the following guidelines:

- Please make sure that the code builds perfectly fine on your local system.
- Make sure that all linters pass, see [Lint of codebase](#lint-of-codebase)
- The PR will have to meet the code standard already available in the repository.
- Explanatory comments related to code functions are required. Please write code comments for a better
understanding of the code for other developers.
- Note that code changes or additions to the `.github` folder (or sub-folders) will not be accepted.

And finally when you are satisfied with your changes, open a new PR.

### Lint of codebase

A set of different linters test the codebase and these must pass in order to get a pull request approved.

#### Linters in GitHub Action

When you create a pull request, a set of linters will run syntax and format checks on different file
types in GitHub actions by making use of a tool called [super-linter][super-linter]. If any of the
linters gives an error, this will be shown in the action connected to the pull request.

In order to speed up development, it's possible to run linters as part of your local development environment.

#### Run super-linter locally

Since super-linter is using a Docker image in GitHub Actions, users of other editors may run it locally
to lint the codebase. For complete instructions and guidance, see super-linter page for [running locally][super-linter-local].

To run a number of linters on the codebase from command line:

```sh
docker run --rm \
-v $PWD:/tmp/lint \
-e RUN_LOCAL=true \
-e LINTER_RULES_PATH=/ \
-e VALIDATE_BASH=true \
-e VALIDATE_DOCKERFILE_HADOLINT=true \
-e VALIDATE_MARKDOWN=true \
-e VALIDATE_SHELL_SHFMT=true \
-e VALIDATE_YAML=true \
ghcr.io/super-linter/super-linter:slim-v6
```

See [`.github/workflows/lint.yml`](.github/workflows/lint.yml) for the exact setup used by this project.

#### Run super-linter interactively

It might be more convenient to run super-linter interactively. Run container and enter command line:

```sh
docker run --rm \
-v $PWD:/tmp/lint \
-w /tmp/lint \
--entrypoint /bin/bash \
-it ghcr.io/super-linter/super-linter:slim-v6
```

Then from the container terminal, the following commands can lint the the code base for different
file types:

```sh
# Lint Dockerfile files
hadolint $(find -type f -name "Dockerfile*")

# Lint Markdown files
markdownlint .

# Lint YAML files
yamllint .

# Lint shell script files
shellcheck $(shfmt -f .)
shfmt -d .
```

To lint only a specific file, replace `.` or `$(COMMAND)` with the file path.

<!-- markdownlint-disable MD034 -->
[issues]: https://github.com/AxisCommunications/docker-compose-acap/issues
[issues_new]: https://github.com/AxisCommunications/docker-compose-acap/issues/new
[issues_bugs]: https://github.com/AxisCommunications/docker-compose-acap/issues?q=label%3Abug
[super-linter]: https://github.com/super-linter/super-linter
[super-linter-local]: https://github.com/super-linter/super-linter/blob/main/docs/run-linter-locally.md

<!-- markdownlint-enable MD034 -->
8 changes: 4 additions & 4 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# syntax=docker/dockerfile:1

ARG DOCKER_VERSION=24.0.2
ARG DOCKER_COMPOSE_VERSION=v2.18.1
ARG DOCKER_VERSION=26.0.0
ARG DOCKER_COMPOSE_VERSION=v2.25.0

ARG REPO=axisecp
ARG ACAPARCH=armv7hf

ARG VERSION=1.10
ARG VERSION=1.3
ARG UBUNTU_VERSION=22.04
ARG NATIVE_SDK=acap-native-sdk

Expand Down Expand Up @@ -40,7 +40,7 @@ RUN git clone --depth 1 -b $PROCPS_VERSION 'https://gitlab.com/procps-ng/procps'

ARG BUILD_CACHE=build.cache
RUN echo ac_cv_func_realloc_0_nonnull=yes >$BUILD_CACHE \
&& echo ac_cv_func_malloc_0_nonnull=yes >>$BUILD_CACHE
&& echo ac_cv_func_malloc_0_nonnull=yes >>$BUILD_CACHE
RUN <<EOF
. /opt/axis/acapsdk/environment-setup*
./autogen.sh
Expand Down
Loading