Skip to content

Commit

Permalink
Merge branch 'rename-master-to-main' of 'https://github.com/jjmerchan…
Browse files Browse the repository at this point in the history
  • Loading branch information
sduenas authored Jan 14, 2025
2 parents fbf40e4 + 09f9bce commit 67d31cb
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ jobs:
check-changelog:
runs-on: ubuntu-latest
steps:
- uses: bitergia/release-tools-check-changelog@master
- uses: bitergia/release-tools-check-changelog@main
6 changes: 3 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Build package using Poetry and store result
uses: chaoss/grimoirelab-github-actions/build@master
uses: chaoss/grimoirelab-github-actions/build@main
with:
artifact-name: sirmordred-dist
artifact-path: dist
Expand Down Expand Up @@ -116,7 +116,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Create a new release on the repository
uses: chaoss/grimoirelab-github-actions/release@master
uses: chaoss/grimoirelab-github-actions/release@main
with:
github-token: ${{ secrets.GITHUB_TOKEN }}

Expand All @@ -125,7 +125,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Publish the package on PyPI
uses: chaoss/grimoirelab-github-actions/publish@master
uses: chaoss/grimoirelab-github-actions/publish@main
with:
artifact-name: sirmordred-dist
artifact-path: dist
Expand Down
14 changes: 7 additions & 7 deletions Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ The final results should be something similar to the image below.

Now that you have the ElasticSearch, Kibiter and MariaDB running on your system and the project configured in the PyCharm, we can execute micro-mordred/sirmordred.

To execute micro-mordred, define a [setup.cfg](https://github.com/chaoss/grimoirelab-sirmordred/blob/master/sirmordred/utils/setup.cfg) and [projects.json](https://github.com/chaoss/grimoirelab-sirmordred/blob/master/sirmordred/utils/projects.json), and
To execute micro-mordred, define a [setup.cfg](https://github.com/chaoss/grimoirelab-sirmordred/blob/main/sirmordred/utils/setup.cfg) and [projects.json](https://github.com/chaoss/grimoirelab-sirmordred/blob/main/sirmordred/utils/projects.json), and
run the following commands, which will collect and enrich the data coming from the git sections and upload the corresponding panels to Kibiter:
```
micro.py --raw --enrich --cfg ./setup.cfg --backends git cocom
Expand Down Expand Up @@ -380,7 +380,7 @@ Following is a list of common problems encountered while setting up GrimoireLab
#### Empty Index [↑](#troubleshooting-)
* Indications and Diagnosis:
Check for the following error after executing [Micro Mordred](https://github.com/chaoss/grimoirelab-sirmordred/tree/master/sirmordred/utils/micro.py)
Check for the following error after executing [Micro Mordred](https://github.com/chaoss/grimoirelab-sirmordred/tree/main/sirmordred/utils/micro.py)
using ```micro.py --raw --enrich --panels --cfg ./setup.cfg --backends git```(Here, using git as backend)
```
[git] Problem executing study enrich_areas_of_code:git, RequestError(400, 'search_phase_execution_exception', 'No mapping
Expand All @@ -393,7 +393,7 @@ Following is a list of common problems encountered while setting up GrimoireLab
There are 2 methods to solve this problem:
Method 1: Disable the param [latest-items](https://github.com/chaoss/grimoirelab-sirmordred/blob/master/sirmordred/utils/setup.cfg#L78) by setting it to false.
Method 1: Disable the param [latest-items](https://github.com/chaoss/grimoirelab-sirmordred/blob/main/sirmordred/utils/setup.cfg#L78) by setting it to false.
Method 2: Delete the local clone of the repo (which is stored in ```~/.perceval/repositories```).
Expand Down Expand Up @@ -979,15 +979,15 @@ About possible solutions:
* (3) can be solved by merging those identities under the same individual, which can be done via SortingHat too.
Note: by default, SortingHat is importing the list of organizations and domains
[from this file](https://github.com/chaoss/grimoirelab/blob/master/default-grimoirelab-settings/organizations.json).
[from this file](https://github.com/chaoss/grimoirelab/blob/main/default-grimoirelab-settings/organizations.json).
#### Add a new organization/domain entry via Hatstall [↑](#how-to-)
[Hatstall](https://github.com/chaoss/grimoirelab-hatstall) is a web interface to interact with SortingHat.
Tip: if you are executing GrimoireLab [via `docker-compose`](https://github.com/chaoss/grimoirelab/tree/master/docker-compose),
Tip: if you are executing GrimoireLab [via `docker-compose`](https://github.com/chaoss/grimoirelab/tree/main/docker-compose),
you can access Hatstall from `http://127.0.0.1:8000/`. Default credentials are `admin`-`admin`, as explained in
[this README section](https://github.com/chaoss/grimoirelab/tree/master/docker-compose#getting-started-in-3-steps).
[this README section](https://github.com/chaoss/grimoirelab/tree/main/docker-compose#getting-started-in-3-steps).
For adding a new organization domain from Hatstall, you have to click on `Organizations` tab on the nav bar, and then:
* First, look for the organization you are interested in (you can navigate though the pages or you can use the search bar).
Expand All @@ -1007,7 +1007,7 @@ able to add new domains for that organization.
- Remove all unused containers, images, and volumes with `docker system prune -a --volumes`.
- Now, execute `docker-compose up -d` using the source code (see - https://github.com/chaoss/grimoirelab-sirmordred/blob/master/Getting-Started.md#source-code-and-docker- )
- Now, execute `docker-compose up -d` using the source code (see - https://github.com/chaoss/grimoirelab-sirmordred/blob/main/Getting-Started.md#source-code-and-docker- )
- Check connection to Elasticsearch with `curl -XGET <elasticsearch-url> -k`.
The output should be the similar to :
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SirMordred [![Build Status](https://github.com/chaoss/grimoirelab-sirmordred/workflows/tests/badge.svg)](https://github.com/chaoss/grimoirelab-sirmordred/actions?query=workflow:tests+branch:master+event:push) [![Coverage Status](https://coveralls.io/repos/github/chaoss/grimoirelab-sirmordred/badge.svg?branch=master)](https://coveralls.io/github/chaoss/grimoirelab-sirmordred?branch=master) [![PyPI version](https://badge.fury.io/py/sirmordred.svg)](https://badge.fury.io/py/sirmordred)
# SirMordred [![Build Status](https://github.com/chaoss/grimoirelab-sirmordred/workflows/tests/badge.svg)](https://github.com/chaoss/grimoirelab-sirmordred/actions?query=workflow:tests+branch:main+event:push) [![Coverage Status](https://coveralls.io/repos/github/chaoss/grimoirelab-sirmordred/badge.svg?branch=main)](https://coveralls.io/github/chaoss/grimoirelab-sirmordred?branch=main) [![PyPI version](https://badge.fury.io/py/sirmordred.svg)](https://badge.fury.io/py/sirmordred)

SirMordred is the tool used to coordinate the execution of the GrimoireLab platform, via two main configuration files, the `setup.cfg` and `projects.json`, which are summarized in their corresponding sections.

Expand Down Expand Up @@ -104,7 +104,7 @@ The template of a backend section is shown above.
Further information about Perceval backends parameters are available at:

* Params details: https://perceval.readthedocs.io/en/latest/perceval/perceval-backends.html
* Examples: https://github.com/chaoss/grimoirelab-sirmordred/blob/master/tests/test_studies.cfg
* Examples: https://github.com/chaoss/grimoirelab-sirmordred/blob/main/tests/test_studies.cfg

Note that some backend sections allow to specify specific enrichment options, which are listed below.

Expand All @@ -121,7 +121,7 @@ Note that some backend sections allow to specify specific enrichment options, wh

A template of a study section is shown above. A complete list of studies parameters is available at:

* https://github.com/chaoss/grimoirelab-sirmordred/blob/master/tests/test_studies.cfg
* https://github.com/chaoss/grimoirelab-sirmordred/blob/main/tests/test_studies.cfg

## Projects.json [&uarr;](#contents)

Expand Down Expand Up @@ -1434,7 +1434,7 @@ studies = [enrich_demography:weblate] (optional)

Micro Mordred is a simplified version of Mordred which omits the use of its scheduler. Thus, Micro Mordred allows running single Mordred tasks (e.g., raw collection, enrichment) per execution.

Micro Mordred is located in the [sirmordred/utils](https://github.com/chaoss/grimoirelab-sirmordred/tree/master/sirmordred/utils/micro.py) folder of this same repository. It can be executed via command line, its parameters are summarized below:
Micro Mordred is located in the [sirmordred/utils](https://github.com/chaoss/grimoirelab-sirmordred/tree/main/sirmordred/utils/micro.py) folder of this same repository. It can be executed via command line, its parameters are summarized below:
```
--debug: execute Micro Mordred in debug mode
Expand Down

0 comments on commit 67d31cb

Please sign in to comment.