This is an automated email from the ASF dual-hosted git repository. jnioche pushed a commit to branch fixREADMEs in repository https://gitbox.apache.org/repos/asf/stormcrawler.git
commit 762434bfa350fc1bd7bdcf65b03e33e366889774 Author: Julien Nioche <[email protected]> AuthorDate: Fri May 30 06:33:02 2025 +0100 Fix versions of SC in the READMEs + added instructions in RELEASING Signed-off-by: Julien Nioche <[email protected]> --- README.md | 2 +- RELEASING.md | 1 + external/opensearch/README.md | 2 +- external/solr/README.md | 2 +- external/warc/README.md | 4 ++-- 5 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8294aa45..7d41707c 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ StormCrawler requires Java 17 or above. To execute tests, it requires you to hav Once Storm is installed, the easiest way to get started is to generate a new StormCrawler project following the instructions below: ```shell -mvn archetype:generate -DarchetypeGroupId=org.apache.stormcrawler -DarchetypeArtifactId=stormcrawler-archetype -DarchetypeVersion=3.2.0 +mvn archetype:generate -DarchetypeGroupId=org.apache.stormcrawler -DarchetypeArtifactId=stormcrawler-archetype -DarchetypeVersion=3.3.0 ``` diff --git a/RELEASING.md b/RELEASING.md index ad9afac5..a37650b3 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -88,6 +88,7 @@ export GPG_TTY=$(tty) - Execute a complete test: `mvn test` - Ensure to have a working Docker environment on your release machine. Otherwise, coverage computation goes wrong and the build will fail. - Check the current results of the last GitHub action runs. +- Upgrade to the latest version of StormCrawler in the README files - Do a trial build: `mvn package -Papache-release,apache-gpg` - Switch to a new branch with a format like **rel-stormcrawler-x.y.z-RC?** - Prepare the release: `mvn release:prepare -Papache-release,apache-gpg` Answer the questions appropriately. The tag name format should be *stormcrawler-x.y.z*. **DO NOT INCLUDE `-rcX` in the tag** diff --git a/external/opensearch/README.md b/external/opensearch/README.md index 63faf71c..502246af 100644 --- a/external/opensearch/README.md +++ b/external/opensearch/README.md @@ -16,7 +16,7 @@ Getting started The easiest way is currently to use the archetype for OpenSearch with: -`mvn archetype:generate -DarchetypeGroupId=org.apache.stormcrawler -DarchetypeArtifactId=stormcrawler-opensearch-archetype -DarchetypeVersion=3.2.0` +`mvn archetype:generate -DarchetypeGroupId=org.apache.stormcrawler -DarchetypeArtifactId=stormcrawler-opensearch-archetype -DarchetypeVersion=3.3.0` You'll be asked to enter a groupId (e.g. com.mycompany.crawler), an artefactId (e.g. stormcrawler), a version, a package name and details about the user agent to use. diff --git a/external/solr/README.md b/external/solr/README.md index edb1722e..37825adb 100644 --- a/external/solr/README.md +++ b/external/solr/README.md @@ -6,7 +6,7 @@ Set of [Apache Solr](https://solr.apache.org/) resources for StormCrawler that a The easiest way is currently to use the archetype for Solr with: -`mvn archetype:generate -DarchetypeGroupId=org.apache.stormcrawler -DarchetypeArtifactId=stormcrawler-solr-archetype -DarchetypeVersion=3.2.0` +`mvn archetype:generate -DarchetypeGroupId=org.apache.stormcrawler -DarchetypeArtifactId=stormcrawler-solr-archetype -DarchetypeVersion=3.3.0` You'll be asked to enter a groupId (e.g. com.mycompany.crawler), an artefactId (e.g. stormcrawler), a version, a package name and details about the user agent to use. diff --git a/external/warc/README.md b/external/warc/README.md index d80f5350..c03f531b 100644 --- a/external/warc/README.md +++ b/external/warc/README.md @@ -30,7 +30,7 @@ To configure the WARCHdfsBolt, include the following snippet in your crawl topol .withPath(warcFilePath); Map<String,String> fields = new HashMap<>(); - fields.put("software:", "Apache StormCrawler 3.2.0 http://stormcrawler.net/"); + fields.put("software:", "Apache StormCrawler 3.3.0 http://stormcrawler.net/"); fields.put("format", "WARC File Format 1.0"); fields.put("conformsTo:", "https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.0/"); @@ -80,7 +80,7 @@ components: - name: "put" args: - "software" - - "Apache StormCrawler 3.2.0 http://stormcrawler.net/" + - "Apache StormCrawler 3.3.0 http://stormcrawler.net/" - name: "put" args: - "format"
