You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by na...@apache.org on 2026/10/19 07:06:07 UTC
(ignite) branch master updated: IGNITE-29160 Fix outdated developer instructions and README content (#13701)
This is an automated email from the ASF dual-hosted git repository.
NSAmelchev pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/master by this push:
new 3c2b5bf390e IGNITE-29160 Fix outdated developer instructions and README content (#13701)
3c2b5bf390e is described below
commit 3c2b5bf390e11f2a59f3b389a5a26209ae2c91c5
Author: Nikita Amelchev <ns...@gmail.com>
AuthorDate: Mon Oct 19 10:05:58 2026 +0300
IGNITE-29160 Fix outdated developer instructions and README content (#13701)
---
.github/PULL_REQUEST_TEMPLATE.md | 2 +-
.github/workflows/commit-check.yml | 2 +-
CONTRIBUTING.md | 12 ++++++------
DEVNOTES.txt | 23 ++++++++++-------------
README.md | 2 --
docs/README.adoc | 2 +-
modules/platforms/dotnet/DEVNOTES.txt | 2 +-
parent/pom.xml | 1 -
8 files changed, 20 insertions(+), 26 deletions(-)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 990d4148964..3cf50833020 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -22,4 +22,4 @@ the `green visa` attached to the JIRA ticket (see tab `PR Check` at [TC.Bot - In
- [Coding Guidelines](https://cwiki.apache.org/confluence/display/IGNITE/Coding+Guidelines)
- [Apache Ignite Teamcity Bot](https://cwiki.apache.org/confluence/display/IGNITE/Apache+Ignite+Teamcity+Bot)
-If you need any help, please email dev@ignite.apache.org or ask anу advice on http://asf.slack.com _#ignite_ channel.
+If you need any help, please email dev@ignite.apache.org or ask any advice on https://the-asf.slack.com _#ignite_ channel.
diff --git a/.github/workflows/commit-check.yml b/.github/workflows/commit-check.yml
index 3af4cbb2d75..3d0b9939d68 100644
--- a/.github/workflows/commit-check.yml
+++ b/.github/workflows/commit-check.yml
@@ -138,7 +138,7 @@ jobs:
./mvnw test-compile -Pdocs -pl :code-snippets -am -B -V -Dmaven.compiler.useIncrementalCompilation=false
check-dotnet:
- name: Сheck .NET code
+ name: Check .NET code
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index bfe136beaf9..a62f3475776 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,7 +1,7 @@
# Contributing to Apache Ignite
## Joining Community and its communication channels
-- Sign-in to Apache JIRA https://issues.apache.org/jira/
-- (To contribute code patches) Sing-in to [Apache Ignite](https://ignite.apache.org/) Continuous Integration server https://ci.ignite.apache.org/
+- Sign in to Apache JIRA https://issues.apache.org/jira/. If you do not have an account, request it at https://selfserve.apache.org/jira-account.html
+- (To contribute code patches) Sign in to [Apache Ignite](https://ignite.apache.org/) Continuous Integration server https://ci2.ignite.apache.org/
- (To contribute documentation to the wiki) Sing-in to [Apache Wiki](https://cwiki.apache.org/confluence/display/IGNITE)
- Subscribe to both Apache [User List - user@ignite.apache.org](https://lists.apache.org/list.html?user@ignite.apache.org)
and [Dev List - dev@ignite.apache.org](https://lists.apache.org/list.html?dev@ignite.apache.org) lists with your personal (non-corporate) email address.
@@ -21,7 +21,7 @@ Thanks!
```
## Needed Contributions
-[Apache Ignite](https://ignite.apache.org/) Community values any type of contributions from [CoPDoC](https://community.apache.org/contributors/#contributing-a-project-copdoc). Community member can contibute to any areas from (Co)mmunity, (P)roject, (Do)cumentation, and (C)ode.
+[Apache Ignite](https://ignite.apache.org/) Community values any type of contributions from [CoPDoC](https://community.apache.org/contributors/#contributing-a-project-copdoc). Community member can contribute to any areas from (Co)mmunity, (P)roject, (Do)cumentation, and (C)ode.
Community values code contributions, but project value non-code contributions too, from writers, editors, testers, etc.
We value user support on the list, as well as providing a summary of [user list](https://lists.apache.org/list.html?user@ignite.apache.org) threads to Apache Ignite developers.
@@ -36,7 +36,7 @@ Apache Ignite prefer to use [consensus to make decisions](http://community.apach
## Contributing Documentation
Documentation can be contributed to
- - End-User documentation https://ignite.apache.org/docs/latest/ . Use Suggest Edits. See also [How To Document](https://cwiki.apache.org/confluence/display/IGNITE/How+to+Document).
+ - End-User documentation https://ignite.apache.org/docs/latest/ . Its sources are in the [docs](docs) directory, see [How To Document](https://cwiki.apache.org/confluence/display/IGNITE/How+to+Document).
- Developer documentation, design documents, IEPs [Apache Wiki](https://cwiki.apache.org/confluence/display/IGNITE). Ask at [Dev List](https://lists.apache.org/list.html?dev@ignite.apache.org) to be added as editor.
- Markdown files, visible at GitHub, e.g. README.md; drawings explaining Apache Ignite & product internals.
- Javadocs for packages (package-info.java), classes, methods, etc.
@@ -46,7 +46,7 @@ You can also blog about the product. It helps users to understand how to use Apa
Feel free to share link to your blog with
[User](https://lists.apache.org/list.html?user@ignite.apache.org) & [Dev](https://lists.apache.org/list.html?dev@ignite.apache.org) lists.
-Blogs are reffered from [Apache Ignite Blogs](https://ignite.apache.org/blogs.html).
+See also the [Apache Ignite Blog](https://ignite.apache.org/blog/).
## Contributing Code
### Project Initial Setup
@@ -65,6 +65,6 @@ Inspection profile is placed to IDEA [Project_Default](.idea/inspectionProfiles/
### Building project
Usually all Maven builds are to be run with skipped tests:
```
-./mvnw -DskipTests
+./mvnw clean install -DskipTests
```
See also [DEVNOTES.txt](DEVNOTES.txt)
diff --git a/DEVNOTES.txt b/DEVNOTES.txt
index 85153ece3ce..a8a35862da3 100644
--- a/DEVNOTES.txt
+++ b/DEVNOTES.txt
@@ -17,9 +17,9 @@ Apache Ignite Maven Build Instructions
./mvnw clean install -Pall-java,licenses -DskipTests
or if you have to build .NET part as well, use the following command:
- (Note that 'doxygen', `docfx`, '.NET Core SDK 3.1', 'PowerShell' should be installed before running this command.)
+ (Note that 'doxygen', `docfx`, '.NET 6 SDK', 'PowerShell' should be installed before running this command.)
- ./mvnw clean install -Pall-java,licenses,platforms -DskipTests -DclientDocs
+ ./mvnw clean install -Pall-java,licenses,build-dotnet -DskipTests -DclientDocs
2) Javadoc generation (optional):
@@ -45,9 +45,9 @@ Apache Ignite with LGPL Maven Build Instructions
./mvnw clean install -Pall-java,licenses -DskipTests
or if you have to build .NET part as well, use the following command:
- (Note that 'doxygen', `docfx`, '.NET Core SDK 3.1', 'PowerShell' should be installed before running this command.)
+ (Note that 'doxygen', `docfx`, '.NET 6 SDK', 'PowerShell' should be installed before running this command.)
- ./mvnw clean install -Pall-java,licenses,platforms -DskipTests -DclientDocs
+ ./mvnw clean install -Pall-java,licenses,build-dotnet -DskipTests -DclientDocs
2) Javadoc generation with LGPL (optional):
@@ -68,11 +68,6 @@ Apache Ignite with NUMA allocator Build Instructions (Linux only)
./mvnw clean install -Pall-java,licenses -DskipTests
- or if you have built Apache Ignite.NET on the first step use following command:
- (Note that 'doxygen' should be installed before running this command.)
-
- ./mvnw clean install -Pall-java,licenses -DskipTests -DclientDocs
-
3) Javadoc generation with NUMA allocator (optional):
./mvnw initialize -Pjavadoc,numa-allocator
@@ -205,15 +200,17 @@ Run tests
=========
To run tests locally use:
- ./mvnw clean test -U -Plgpl,examples,-clean-libs,-release -Dmaven.test.failure.ignore=true -DfailIfNoTests=false -Dtest=%TEST_PATTERN%
+ ./mvnw clean test -U -Pall-java,lgpl -Dmaven.test.failure.ignore=true -Dsurefire.failIfNoSpecifiedTests=false -DFORK_COUNT_SET_TO_1 -Dtest=%TEST_PATTERN%
+
+For example, %TEST_PATTERN% can be 'org.apache.ignite.testsuites.IgniteBasicTestSuite' or 'GridCachePartitionedFullApiSelfTest#testGet'
-For example, %TEST_PATTERN% can be 'org.apache.ignite.testsuites.IgniteBasicTestSuite' or 'GridCacheLocalAtomicFullApiSelfTest#testGet'
+FORK_COUNT_SET_TO_1 forks a test JVM with the argLine options from parent/pom.xml, otherwise pass them via MAVEN_OPTS.
Test suites
=========
-All unit tests must be included in any test suite. Travis runs a check for that. To check it locally run for the root project:
+All unit tests must be included in any test suite. GitHub Actions runs a check for that. To check it locally run for the root project:
- ./mvnw test -Pcheck-test-suites
+ ./mvnw test -Pcheck-test-suites,all-java
If you want to check a single module only:
diff --git a/README.md b/README.md
index 77cfcbadd3d..96163324305 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,6 @@
<a href="https://ignite.apache.org/"><img src="https://github.com/apache/ignite-website/blob/master/assets/images/apache_ignite_logo.svg" hspace="20"/></a>
-[](https://travis-ci.org/apache/ignite)
[](https://www.apache.org/licenses/LICENSE-2.0.html)
[](https://search.maven.org/search?q=org.apache.ignite)
[](https://ignite.apache.org/download.cgi)
@@ -13,7 +12,6 @@
* This repository is Ignite 2
* See [apache/ignite-3](https://github.com/apache/ignite-3) for Ignite 3
-* Both versions are actively developed
## What is Apache Ignite?
diff --git a/docs/README.adoc b/docs/README.adoc
index 118944bcfd4..9cd0306a802 100644
--- a/docs/README.adoc
+++ b/docs/README.adoc
@@ -226,7 +226,7 @@ Source code files are located in the `docs/_docs/code-snippets/{language}` folde
To add a code snippet to a page, follow these steps:
-* Create a file in the code snippets directory, e.g. _docs/code-snippets/java/org/apache/ignite/snippets/JavaThinClient.java
+* Create a file in the code snippets directory, e.g. _docs/code-snippets/java/src/main/java/org/apache/ignite/snippets/JavaThinClient.java
* Enclose the piece of code you want to include within named tags (see https://asciidoctor.org/docs/user-manual/#by-tagged-regions). Give the tag a self-evident name.
For example:
diff --git a/modules/platforms/dotnet/DEVNOTES.txt b/modules/platforms/dotnet/DEVNOTES.txt
index ea102c600a8..6d98537e55d 100644
--- a/modules/platforms/dotnet/DEVNOTES.txt
+++ b/modules/platforms/dotnet/DEVNOTES.txt
@@ -20,7 +20,7 @@ Resulting binaries will be in bin folder, and NuGet packages in nupkg folder.
Build Apache Ignite .NET with Maven
===================================
-Note that .NET Core SDK 3.1 and PowerShell must be installed first.
+Note that .NET 6 SDK and PowerShell must be installed first.
The command below will build the binaries and NuGet packages with Maven:
diff --git a/parent/pom.xml b/parent/pom.xml
index b3405e38184..3ea7dca6691 100644
--- a/parent/pom.xml
+++ b/parent/pom.xml
@@ -888,7 +888,6 @@
<inputExclude>**/.gitignore</inputExclude>
<inputExclude>**/.git</inputExclude>
<inputExclude>**/.asf.yaml</inputExclude>
- <inputExclude>.travis.yml</inputExclude>
<inputExclude>.github/PULL_REQUEST_TEMPLATE.md</inputExclude>
<inputExclude>idea/ignite_codeStyle.xml</inputExclude>
<inputExclude>**/DEVNOTES*.txt</inputExclude>