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

docs: documentation update #633

Merged
merged 8 commits into from
Nov 25, 2024
Merged

docs: documentation update #633

merged 8 commits into from
Nov 25, 2024

Conversation

rjaegers
Copy link
Member

@rjaegers rjaegers commented Nov 7, 2024

Pull Request

Description of changes

This PR includes several small updates to the documentation. Clarifying the supported platforms and target architectures better and using more neutral terms.

Checklist

  • I have followed the contribution guidelines for this repository
  • I have added tests for new behavior, and have not broken any existing tests
  • I have added or updated relevant documentation
  • I have verified that all added components are accounted for in the SBOM

@rjaegers rjaegers requested a review from a team as a code owner November 7, 2024 11:29
Copy link
Contributor

github-actions bot commented Nov 7, 2024

Compressed layer size comparison

Comparing ghcr.io/philips-software/amp-devcontainer-rust:latest to ghcr.io/philips-software/amp-devcontainer-rust@sha256:bdb66559123f76cf183de23ea9b68bc59b5faa2b2fb75dba84a943188a8304b4

OS/Platform Previous Size Current Size Delta
linux/amd64 459.82M 459.82M 265.00 (+0.00%)
linux/arm64 599.31M 599.31M 617.00 (+0.00%)

Copy link
Contributor

github-actions bot commented Nov 7, 2024

Compressed layer size comparison

Comparing ghcr.io/philips-software/amp-devcontainer-cpp:latest to ghcr.io/philips-software/amp-devcontainer-cpp@sha256:b8560e17bf90d5cf3a317b5436848d102643fa40c63791572cb4e978b729be1a

OS/Platform Previous Size Current Size Delta
linux/amd64 650.48M 650.45M -24.52K (-0.00%)
linux/arm64 643.16M 643.14M -17.49K (-0.00%)

Copy link
Contributor

github-actions bot commented Nov 7, 2024

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 16 0 0.09s
✅ DOCKERFILE hadolint 2 0 0.61s
✅ GHERKIN gherkin-lint 2 0 0.76s
✅ JSON npm-package-json-lint yes no 0.32s
✅ JSON prettier 15 1 0 0.39s
✅ JSON v8r 14 0 14.6s
✅ MARKDOWN markdownlint 8 0 0 0.71s
✅ MARKDOWN markdown-table-formatter 8 0 0 0.23s
✅ REPOSITORY checkov yes no 16.08s
✅ REPOSITORY gitleaks yes no 0.23s
✅ REPOSITORY git_diff yes no 0.01s
✅ REPOSITORY grype yes no 9.3s
✅ REPOSITORY secretlint yes no 1.02s
✅ REPOSITORY syft yes no 1.25s
✅ REPOSITORY trivy yes no 9.01s
✅ REPOSITORY trivy-sbom yes no 0.08s
✅ REPOSITORY trufflehog yes no 3.06s
✅ SPELL lychee 57 0 1.26s
✅ YAML prettier 21 0 0 0.79s
✅ YAML v8r 21 0 12.45s
✅ YAML yamllint 21 0 0.41s

See detailed report in MegaLinter reports

You could have the same capabilities but better runtime performances if you use a MegaLinter flavor:

MegaLinter is graciously provided by OX Security

Copy link
Contributor

github-actions bot commented Nov 7, 2024

Test Results

 2 files  ±0   2 suites  ±0   1m 23s ⏱️ ±0s
29 tests ±0  29 ✅ ±0  0 💤 ±0  0 ❌ ±0 
31 runs  ±0  31 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit ad65bdd. ± Comparison against base commit 7d12cfc.

♻️ This comment has been updated with latest results.

@rjaegers rjaegers enabled auto-merge November 7, 2024 14:59
@rjaegers rjaegers disabled auto-merge November 7, 2024 15:00
@rjaegers rjaegers changed the title docs: move more requirements into feature files docs: documentation update Nov 7, 2024
@rjaegers rjaegers added this pull request to the merge queue Nov 25, 2024
Merged via the queue into main with commit 96c33db Nov 25, 2024
26 checks passed
@rjaegers rjaegers deleted the feature/documentation-update branch November 25, 2024 16:32
Copy link
Contributor

Pull Request Report (#633)

Static measures

Description Value
Number of added lines 14
Number of deleted lines 10
Number of changed files 4
Number of commits 8
Number of reviews 4
Number of comments (w/o review comments) 5
Number of reviews that contains a comment to resolve 3
Number of reviews that requested a change from the author 0
Number of reviews that approved the Pull Request 1
Get the total number of participants of a Pull Request 4

Time related measures

Description Value
PR lead time (from creation to close of PR) 18.2 Days
Time that was spend on the branch before the PR was created 1.6 Hours
Time that was spend on the branch before the PR was merged 18.3 Days
Time to merge after last review 12.3 Days

Status check related measures

Description Value
Total runtime for last status check run (Workflow for PR) 2.6 Hours
Total time spend in last status check run on PR 2.7 Hours

Copy link
Contributor

🎉 Hooray! The changes in this pull request went live with the release of v5.5.1 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants