diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1e5084b..19de288 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -49,7 +49,7 @@ repos: hooks: - id: check-branch-name args: - - '^master$' + - '^main$' - '^development$' - '^devops/([a-z][a-z0-9]*)(-[a-z0-9]+)*$' - '^doc/([a-z][a-z0-9]*)(-[a-z0-9]+)*$' diff --git a/README.md b/README.md index e1e02bb..8ccb81e 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ A library to help digital twins and data services talk to one another. Read more at [twined.readthedocs.io](https://twined.readthedocs.io) [![PyPI version](https://badge.fury.io/py/twined.svg)](https://badge.fury.io/py/twined) -[![Build Status](https://travis-ci.com/octue/twined.svg?branch=master)](https://travis-ci.com/octue/twined) -[![codecov](https://codecov.io/gh/octue/twined/branch/master/graph/badge.svg)](https://codecov.io/gh/octue/twined) +[![Build Status](https://github.com/octue/twined/workflows/python-ci/badge.svg)](https://github.com/octue/twined) +[![codecov](https://codecov.io/gh/octue/twined/branch/main/graph/badge.svg)](https://codecov.io/gh/octue/twined) [![Documentation Status](https://readthedocs.org/projects/twined/badge/?version=latest)](https://twined.readthedocs.io/en/latest/?badge=latest) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) @@ -45,14 +45,14 @@ roadmap, into which you can make your PR. We'll help review the changes and impr The process for creating a new release is as follows: 1. Check out a branch for the next version, called `vX.Y.Z` -2. Create a Pull Request into the `master` branch. +2. Create a Pull Request into the `main` branch. 3. Undertake your changes, committing and pushing to branch `vX.Y.Z` 4. Ensure that documentation is updated to match changes, and increment the changelog. **Pull requests which do not update documentation will be refused.** 5. Ensure that test coverage is sufficient. **Pull requests that decrease test coverage will be refused.** 6. Ensure code meets style guidelines (pre-commit scripts and flake8 tests will fail otherwise) 7. Address Review Comments on the PR 8. Ensure the version in `setup.py` is correct and matches the branch version. -9. Merge to master. Successful test, doc build, flake8 and a new version number will automatically create the release on pypi. +9. Merge to main. Successful test, doc build, flake8 and a new version number will automatically create the release on pypi. 10. Go to code > releases and create a new release on GitHub at the same SHA. diff --git a/docs/source/anatomy_values.rst b/docs/source/anatomy_values.rst index 71c0724..184063e 100644 --- a/docs/source/anatomy_values.rst +++ b/docs/source/anatomy_values.rst @@ -61,7 +61,7 @@ Let's look at basic examples for twines containing each of these strands: This *twine* contains an example ``configuration_values_schema`` with one control parameter. - `Many more detailed and specialised examples are available in the GitHub repository `_ + `Many more detailed and specialised examples are available in the GitHub repository `_ .. code-block:: javascript