Skip to content

Commit

Permalink
Merge branch 'main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
xavierfacq authored Oct 25, 2024
2 parents b350522 + 47087c2 commit 057b6ec
Show file tree
Hide file tree
Showing 32 changed files with 512 additions and 619 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/blog-validator.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
runs-on: ubuntu-latest
steps:

- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
persist-credentials: false

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/check-adopters.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ jobs:
runs-on: ubuntu-latest
steps:

- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
persist-credentials: false

- run: python3 .github/workflows/fetch-adopters.py

- uses: gr2m/create-or-update-pull-request-action@86ec1766034c8173518f61d2075cc2a173fb8c97 # v1.9.4
- uses: gr2m/create-or-update-pull-request-action@488876a65a2ca38b7eb05e9086166337087f5323 # v1.10.0
env:
GITHUB_TOKEN: ${{ secrets.ADOPTIUM_BOT_TOKEN }}
with:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/check-contributors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
runs-on: ubuntu-latest
steps:

- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
persist-credentials: false
fetch-depth: 0
Expand Down Expand Up @@ -68,7 +68,7 @@ jobs:
done
fi
- uses: gr2m/create-or-update-pull-request-action@86ec1766034c8173518f61d2075cc2a173fb8c97 # v1.9.4
- uses: gr2m/create-or-update-pull-request-action@488876a65a2ca38b7eb05e9086166337087f5323 # v1.10.0
env:
GITHUB_TOKEN: ${{ secrets.ADOPTIUM_BOT_TOKEN }}
with:
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ jobs:
name: Run CI
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
- uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: 20
cache: npm
Expand All @@ -27,6 +27,6 @@ jobs:
- run: npm run coverage

- name: Upload coverage to Codecov
uses: codecov/codecov-action@e28ff129e5465c2c0dcc6f003fc735cb6ae0c673 # v4.5.0
uses: codecov/codecov-action@b9fd7d16f6d7d1b5d2bec1a2887e65ceed900238 # v4.6.0
with:
token: ${{ secrets.CODECOV_TOKEN }}
8 changes: 4 additions & 4 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ jobs:

steps:
- name: Checkout repository
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@461ef6c76dfe95d5c364de2f431ddbd31a417628 # v3.26.9
uses: github/codeql-action/init@662472033e021d55d94146f66f6058822b0b39fd # v3.27.0
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
Expand All @@ -56,7 +56,7 @@ jobs:
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@461ef6c76dfe95d5c364de2f431ddbd31a417628 # v3.26.9
uses: github/codeql-action/autobuild@662472033e021d55d94146f66f6058822b0b39fd # v3.27.0

# ℹ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl
Expand All @@ -70,4 +70,4 @@ jobs:
# make release

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@461ef6c76dfe95d5c364de2f431ddbd31a417628 # v3.26.9
uses: github/codeql-action/analyze@662472033e021d55d94146f66f6058822b0b39fd # v3.27.0
2 changes: 1 addition & 1 deletion .github/workflows/linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:

steps:
- name: Checkout Code
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0
persist-credentials: false
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/locale-checker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:

steps:
- name: Checkout Code
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
persist-credentials: false
fetch-depth: 0
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/ossf-scorecard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,19 @@ jobs:
id-token: write

steps:
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
persist-credentials: false
- uses: ossf/scorecard-action@62b2cac7ed8198b15735ed49ab1e5cf35480ba46 # v2.4.0
with:
results_file: results.sarif
results_format: sarif
publish_results: true
- uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0
- uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
with:
name: SARIF file
path: results.sarif
retention-days: 5
- uses: github/codeql-action/upload-sarif@461ef6c76dfe95d5c364de2f431ddbd31a417628 # v3.26.9
- uses: github/codeql-action/upload-sarif@662472033e021d55d94146f66f6058822b0b39fd # v3.27.0
with:
sarif_file: results.sarif
4 changes: 2 additions & 2 deletions .github/workflows/update_snapshot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ jobs:
if: startsWith(github.event.comment.body, '/update-snapshot')
steps:
- name: Checkout repository
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
ref: ${{ github.event.issue.head_ref }}
repository: ${{ github.event.issue.repository.full_name }}
fetch-depth: 0

- name: Set up Node.js
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: 20
cache: npm
Expand Down
8 changes: 7 additions & 1 deletion content/asciidoc-pages/docs/faq/index.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Frequently Asked Questions
:page-authors: gdams, karianna, sxa555, aahlenst, sxa, tellison, kemitix, Fishbowler, Saurabh-Daware, xavierfacq
:page-authors: gdams, karianna, sxa555, aahlenst, sxa, tellison, kemitix, Fishbowler, Saurabh-Daware, xavierfacq, smlambert

We have gathered together a few frequently asked questions (FAQs) into
this document.
Expand Down Expand Up @@ -166,6 +166,12 @@ resources so we constantly review the download and usage demand to ensure we
are releasing on platforms relevant to a large set of users. The current
set of platforms we target in our build and test process is listed link:/supported-platforms[here].

== Why is my favorite architecture and operating system no longer supported?

The link:/supported-platforms[supported-platforms] list reflects the intersection of what is supported in the upstream OpenJDK project and what the Adoptium project chooses to build, test and support. The choice to drop support is determined by a number of criteria, including consumer demand, available funding through sponsorship, resource support for machines, and engineers to help at the project.

The most common reason a platform is no longer supported is it's deprecation in the upstream OpenJDK project. For example, in answer to the question "why is Windows x86 32bit no longer supported in Java 21+?", one can see https://openjdk.org/jeps/449[JEP 449] where that port is deprecated for removal.

== Can I automate the download of Temurin binaries?

Yes! There is a rich https://api.adoptium.net/q/swagger-ui/[download API]
Expand Down
16 changes: 8 additions & 8 deletions content/asciidoc-pages/docs/first-timer-support/index.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Eclipse Adoptium(R) First Timers Support
:page-authors: MBoegers, hendrikebbers, gdams, tellison, Ndacyayisenga-droid
:page-authors: MBoegers, hendrikebbers, gdams, tellison, Ndacyayisenga-droid, LemongrabThree
:description: Support with first time contributions
:keywords: adoptium documentation contribute first-time
:icons: font
Expand All @@ -13,7 +13,7 @@ Therefore it is quite important for us to provide help to people that want to st
This documentation is still work in progress and some points that are mentioned are ideas for the future that has not been established yet.
====

Adoptium provides several issues that are labeled as https://github.com/orgs/adoptium/projects/[good first issue].
Adoptium provides several issues that are labeled as https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue].
All this issues are perfect to start working on an open source project.
The issues provide user friendly descriptions and a lot or helpful links to documentations and tutorials to directly start working on such issue.
Even if you are not really familiar with GitHub in general the issues link to user friendly tutorials that will help users to
Expand All @@ -25,31 +25,31 @@ In GitHub you can find https://github.com/issues?q=org%3AAdoptium+label%3A%22goo

== Templates

We are currently working on an issue template for issues that are labeled as a https://github.com/orgs/adoptium/projects/[good first issue].
We are currently working on an issue template for issues that are labeled as a https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue].
https://gist.github.com/hendrikebbers/8e4dec9ddea5e2a420080d1314af025f[The current version of the issue template] and
https://gist.github.com/hendrikebbers/0f9cdd18076343b3bbe5f2d162733b6e[a section about "First timers support" to contributing.md files]
are currently in development.

== Workflow to create good first issues

Whenever you assume that an issue could be a https://github.com/orgs/adoptium/projects/[good first issue] you should label it with the **`good first issue - candidate`** label.
By doing so it can be reviewed and modified to become a https://github.com/orgs/adoptium/projects/[good first issue]
Whenever you assume that an issue could be a https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue] you should label it with the **`good first issue - candidate`** label.
By doing so it can be reviewed and modified to become a https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue]

In GitHub you can find https://github.com/issues?q=org%3AAdoptium+label%3A%22good+first+issue+-+candidate%22+is%3Aopen[a list of all issues that are labeled by **`good first issue - candidate`**].

All issues that are labeled as **`good first issue - candidate`** should be reviewed and maybe refactored to become https://github.com/orgs/adoptium/projects/[good first issue] labeled issues.
All issues that are labeled as **`good first issue - candidate`** should be reviewed and maybe refactored to become https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue] labeled issues.
Here the following rules should be applied:

- The title of the issue must specify the problem
- The description of the issue must be based on https://gist.github.com/hendrikebbers/0f9cdd18076343b3bbe5f2d162733b6e[our **`good first issue`** template]
- The issue should not contain any comments. Comments make it already harder to understand for a newbie.
All relevant information that are in the comments should be added to the description of the issue.
The comments should be removed afterwards.
If this is not possible the best solution is to create a new issue for the https://github.com/orgs/adoptium/projects/[good first issue], link it to the original one, and close the original one.
If this is not possible the best solution is to create a new issue for the https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue], link it to the original one, and close the original one.
- When defining the description of the issue it always makes sense to link to documentations or helpful files (maybe even directly to the code)
to help a newcomer to find the right starting point to work on the issue.

Once the issue is refactored and reviewed it should be labeled as https://github.com/orgs/adoptium/projects/[good first issue] and the **`good first issue - candidate`** label should be removed.
Once the issue is refactored and reviewed it should be labeled as https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue] and the **`good first issue - candidate`** label should be removed.
Next to this we should label all this issues with **`help wanted`** and **`Hacktoberfest`**.

== Links & Resources
Expand Down
16 changes: 8 additions & 8 deletions content/asciidoc-pages/docs/first-timer-support/index.de.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Eclipse Adoptium(R) First Timers Support
:page-authors: gdams, HanSolo, hendrikebbers, tellison, xavierfacq
:page-authors: gdams, HanSolo, hendrikebbers, tellison, xavierfacq, LemongrabThree
:page-based-on: 50dc526fadcdd7dd03b386f112ac1ab4043bb554
:description: Support with first time contributions
:keywords: adoptium documentation contribute first-time
Expand All @@ -14,7 +14,7 @@ Deshalb ist es für uns wichtig, Menschen, die mit OpenSource arbeiten wollen, z
Diese Dokumentation is noch in Arbeit und einige Punkte, welche erwähnt werden, sind Ideen für die Zukunft und heute noch nicht final definiert.
====

Adoptium bietet mehrere Issues an, welche als **`good first issue`** markiert sind.
Adoptium bietet mehrere Issues an, welche als https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue] markiert sind.
Alle diese Issues sind perfekt dafür geeignet, um mit der Arbeit an einem Open-Source-Projekt zu beginnen.
Die Issues bieten benutzerfreundliche Beschreibungen und viele hilfreiche Links zu Dokumentationen und Tutorials, um direkt mit der Arbeit
an einem solchen Issue beginnen zu können.
Expand All @@ -27,29 +27,29 @@ In GitHub finden Sie https://github.com/issues?q=org%3AAdoptium+label%3A%22good+

== Vorlagen

Wir arbeiten derzeit an einer Vorlage für Issues welche als **`good first issue`** gekennzeichnet sind.
Wir arbeiten derzeit an einer Vorlage für Issues welche als https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue] gekennzeichnet sind.
https://gist.github.com/hendrikebbers/8e4dec9ddea5e2a420080d1314af025f[Die aktuelle Version der Vorlage] und
https://gist.github.com/hendrikebbers/0f9cdd18076343b3bbe5f2d162733b6e[ein Abschnitt über die "Unterstützung für Anfänger"]
sind zur Zeit in der Entwicklung.

== Arbeitsablauf zur Erstellung eines "good first issues"

Wann immer Sie davon ausgehen dass ein Thema ein **`good first issue`** sein könnte, sollten Sie es mit dem Label **`good first issue - candidate`** versehen.
Auf diese Weise kann es überprüft und geändert werden, damit es ein **`good first issue`** wird.
Wann immer Sie davon ausgehen dass ein Thema ein https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue] sein könnte, sollten Sie es mit dem Label **`good first issue - candidate`** versehen.
Auf diese Weise kann es überprüft und geändert werden, damit es ein https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue] wird.

In GitHub finden Sie https://github.com/issues?q=org%3AAdoptium+label%3A%22good+first+issue+-+candidate%22+is%3Aopen[eine Liste aller Issues, welche mit **`good first issue - candidate`** gekennzeichnet sind].

Alle Issues, die als **`good first issue - candidate`** gekennzeichnet sind, sollten überprüft und eventuell überarbeitet werden, um als **`good first issue`** gekennzeichnet werden zu können.
Alle Issues, die als **`good first issue - candidate`** gekennzeichnet sind, sollten überprüft und eventuell überarbeitet werden, um als https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue] gekennzeichnet werden zu können.
Dabei sollten folgende Regeln beachtet werden:

- Der Titel des Issues muss das Problem beschreiben
- Die Beschreibung des Issues muss auf https://gist.github.com/hendrikebbers/0f9cdd18076343b3bbe5f2d162733b6e[unserer **`good first issue`** Vorlage basieren]
- Das Issue sollte keine Kommentare enthalten. Kommentare machen es für einen Neuling schwerer den Issue zu verstehen. Alle relevanten Informationen, welche in den Kommentaren stehen, sollten in die Beschreibung des Problems aufgenommen werden. Die Kommentare sollten anschließend entfernt werden.
Wenn dieses nicht möglich ist, ist die beste Lösung, einen neuen Issue für den **`good first issue`** anzulegen, diesen mit dem ursprünglichen Issue zu verknüpfen und den ursprünglichen
Wenn dieses nicht möglich ist, ist die beste Lösung, einen neuen Issue für den https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue] anzulegen, diesen mit dem ursprünglichen Issue zu verknüpfen und den ursprünglichen
Issue zu schließen.
- Bei der Beschreibung des Problems ist es immer sinnvoll, auf Dokumentationen oder hilfreiche Dateien zu verlinken (eventuell sogar direkt auf den Code) um einem Neuling zu helfen den richtigen Ausgangspunkt für die Arbeit an dem Problem zu finden.

Sobald das Problem überarbeitet und überprüft wurde, sollte es als **`good first issue`** gekennzeichnet werden und die Kennzeichnung **`good first issue - candidate`** sollte entfernt werden.
Sobald das Problem überarbeitet und überprüft wurde, sollte es als https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3Aadoptium+archived%3Afalse+label%3A%22good+first+issue%22[good first issue] gekennzeichnet werden und die Kennzeichnung **`good first issue - candidate`** sollte entfernt werden.
Außerdem sollten wir alle diese Probleme mit **`help wanted`** und **`Hacktoberfest`** kennzeichnen.

== Links & Resources
Expand Down
Loading

0 comments on commit 057b6ec

Please sign in to comment.