Skip to content
Snippets Groups Projects
Commit 2d1069b2 authored by Moul's avatar Moul
Browse files

[mod] #408: Switch default branch from dev/master to main

Change in the CI, changes in the documentation

Enable branch check in release.sh, can be commented for releases
on other branches for maintenance releases.
parent d6e4af64
No related branches found
No related tags found
No related merge requests found
Pipeline #15309 passed
......@@ -176,7 +176,7 @@ pages:
extends: .changes
needs: ["tests:3.9:coverage"]
rules:
- if: $CI_COMMIT_BRANCH == "dev"
- if: $CI_COMMIT_BRANCH == "main"
stage: coverage
script: mv cov_html/ public/
artifacts:
......
......@@ -13,9 +13,8 @@ Dependencies will be installed in it in order to have Silkaj running and to have
- We prefer fast-forward and rebase method than having a merge commit. This in order to have a clean history.
## Branches
- `master` branch as stable
- maintainance branches, to maintain a stable version while developing future version with breaking changes. For instance: `0.7`
- `dev` branch
- `main`: development and stable branch
- maintainance branches, to maintain a stable version while developing future version with breaking changes. For instance: `0.10`
## Developing with DuniterPy
[DuniterPy](https://git.duniter.org/clients/python/duniterpy) is a Python library for Duniter clients.
......
<img src="https://git.duniter.org/clients/python/silkaj/raw/dev/logo/silkaj_logo.svg" width="250" />
<img src="https://git.duniter.org/clients/python/silkaj/raw/main/logo/silkaj_logo.svg" width="250" />
# Silkaj
[![Version](https://img.shields.io/pypi/v/silkaj.svg)](https://pypi.python.org/pypi/silkaj)
......@@ -6,9 +6,9 @@
[![Python versions](https://img.shields.io/pypi/pyversions/silkaj.svg)](https://pypi.python.org/pypi/silkaj)
[![Code format](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![Coverage report](https://git.duniter.org/clients/python/silkaj/badges/dev/coverage.svg)](https://clients.duniter.io/python/silkaj/index.html)
[![Coverage report](https://git.duniter.org/clients/python/silkaj/badges/main/coverage.svg)](https://clients.duniter.io/python/silkaj/index.html)
[![Website](https://img.shields.io/website/https/silkaj.duniter.org.svg)](https://silkaj.duniter.org)
[![Dev pipeline status](https://git.duniter.org/clients/python/silkaj/badges/dev/pipeline.svg)](https://git.duniter.org/clients/python/silkaj/)
[![Dev pipeline status](https://git.duniter.org/clients/python/silkaj/badges/main/pipeline.svg)](https://git.duniter.org/clients/python/silkaj/)
Powerfull, lightweight, and multi-platform command line client written with Python for Ğ1 and Ğ1-Test currencies
- [Website](https://silkaj.duniter.org)
......
......@@ -8,8 +8,8 @@ readme = "README.md"
license = "AGPL-3.0-or-later"
homepage = "https://silkaj.duniter.org"
repository = "https://git.duniter.org/clients/python/silkaj"
documentation = "https://git.duniter.org/clients/python/silkaj/tree/dev/doc"
urls = { Changelog = "https://git.duniter.org/clients/python/silkaj/-/blob/dev/CHANGELOG.md" }
documentation = "https://git.duniter.org/clients/python/silkaj/tree/main/doc"
urls = { Changelog = "https://git.duniter.org/clients/python/silkaj/-/blob/main/CHANGELOG.md" }
keywords = ["g1", "duniter", "cryptocurrency", "librecurrency", "RTM"]
include = ["g1_monetary_license/g1_monetary_license_*.rst"]
......
......@@ -16,8 +16,8 @@ check_version_format() {
check_branch() {
branch=`git rev-parse --abbrev-ref HEAD`
if [[ "$branch" != "master" ]]; then
error_message "Current branch should be 'master'"
if [[ "$branch" != "main" ]]; then
error_message "Current branch should be 'main'"
fi
}
......@@ -46,6 +46,6 @@ error_message() {
check_argument_specified
check_version_format
#check_branch
check_branch
update_version
commit_tag
......@@ -3,7 +3,7 @@
## Introduction
The Silkaj team is pleased to announce the release of Silkaj 0.8.0. A new team member joined us at the beginning of this development cycle: Matograine. We highly appreciate his commitment, his improvements of the transaction code and his work on the checksum.
This release comes along with a number of new features and improvements.
The most important of them are highlighted in this article, if you are looking for a comprehensive list of changes, check out the [changelog](https://git.duniter.org/clients/python/silkaj/blob/dev/CHANGELOG.md).
The most important of them are highlighted in this article, if you are looking for a comprehensive list of changes, check out the [changelog](https://git.duniter.org/clients/python/silkaj/blob/main/CHANGELOG.md).
Version 0.8.0 was done in 145 commits, and features seven major improvements:
1. `membership`: We developed a command to allow users to send membership documents.
......@@ -180,7 +180,7 @@ We migrated the packaging and the dependency management tool from Pipenv to Poet
In comparison, [Poetry](https://python-poetry.org/) is a well thought and stable tool which has been released by the end of 2019. In the former development environment, we had to define the dependencies twice in the `requirements.txt`, `setup.{py,cfg}`, `Pipenv` files. Poetry, however, supports the `pyproject.toml` file standardized by the Python project and is able to define the dependencies at once.
If you would like to install Silkaj for development purposes, please follow [this tutorial](https://git.duniter.org/clients/python/silkaj/-/blob/dev/doc/install_poetry.md). You may also interested by checking the newly introduced [contribution process documentation `CONTRIBUTING.md`](https://git.duniter.org/clients/python/silkaj/-/blob/dev/CONTRIBUTING.md).
If you would like to install Silkaj for development purposes, please follow [this tutorial](https://git.duniter.org/clients/python/silkaj/-/blob/main/doc/install_poetry.md). You may also interested by checking the newly introduced [contribution process documentation `CONTRIBUTING.md`](https://git.duniter.org/clients/python/silkaj/-/blob/main/CONTRIBUTING.md).
### B. Automatic container generation
We set up an [automated pipeline to generate containers](https://git.duniter.org/docker/python3/poetry/) for all supported Python versions: 3.5, 3.6, 3.7, and 3.8. These containers are based on official Python containers, which use Debian Buster Slim. On top of that, Poetry, `libsodium`, and other development tools are installed to continually check and test Silkaj in its pipeline. Since DuniterPy uses the same containers, it also profits from this automated container generation.
......
......@@ -8,7 +8,7 @@ To install this pre-release version from PyPI, use this command:
```sh
pip3 install silkaj --user --upgrade --pre
```
Please test it globally, and check [the changelog](https://git.duniter.org/clients/python/silkaj/-/blob/dev/CHANGELOG.md#v090rc-24th-march-2021) which contains the changes which happen during this development cycle.
Please test it globally, and check [the changelog](https://git.duniter.org/clients/python/silkaj/-/blob/main/CHANGELOG.md#v090rc-24th-march-2021) which contains the changes which happen during this development cycle.
Pay a special attention to the transaction part where a part of the algorithm changed.
There are new options on following commands:
```sh
......
......@@ -2,7 +2,7 @@
## Introduction
The Silkaj team is pleased to announce the release of Silkaj 0.9.0.
The most important changes are highlighted in this article, if you are looking for a comprehensive list of changes, check out the [changelog](https://git.duniter.org/clients/python/silkaj/blob/dev/CHANGELOG.md).
The most important changes are highlighted in this article, if you are looking for a comprehensive list of changes, check out the [changelog](https://git.duniter.org/clients/python/silkaj/blob/main/CHANGELOG.md).
#### Transaction
Silkaj is now properly handling the transaction document size limit.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment