Skip to content

Commit

Permalink
Merge pull request #135 from Capitains/setup_correction
Browse files Browse the repository at this point in the history
Setup correction
  • Loading branch information
sonofmun authored Jul 4, 2018
2 parents ef43655 + 584d5e7 commit e767519
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 7 deletions.
4 changes: 4 additions & 0 deletions CHANGES.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 1.2.2 - 2018-07-04

- Added requirements.txt to MANIFEST.in so that it will be included in PyPI

## 1.2.1 - 2018-07-04

- Added required validators package to setup.py
Expand Down
3 changes: 2 additions & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
include HookTest/resources/*.rng
include CHANGES.txt
include CHANGES.txt
include requirements.txt
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ HookTest can now be run on the Travis Continuous Integration (CI) platform. This

Once you have done this, you will need to add a `.travis.yml` file to root folder of your repository. (Note that the name of the file starts with a period ('.').) Use the following as a template for your own `.travis.yml` file:

.. code-block:: yml
.. code-block:: yaml
language: python
python:
Expand Down Expand Up @@ -158,7 +158,7 @@ Once you have done this, you will need to add a `.travis.yml` file to root folde
To help you set up this file for your own repository, a line-by-line explanation follows.

.. code-block:: yml
.. code-block:: yaml
language: python
python:
Expand All @@ -169,14 +169,14 @@ To help you set up this file for your own repository, a line-by-line explanation
These first 5 lines are for the basic setup of HookTest on Travis. Do not change them.

.. code-block:: yml
.. code-block:: yaml
script: hooktest --scheme epidoc --workers 3 --verbose --manifest --console --countword --allowfailure ./
This line runs HookTest. The parameters are those described in the parameter table above. If you do not want to make a new release of your corpus unless it is 100% CapiTainS-compliant, then remove the `--allowfailure` parameter. Without this parameter, the build will fail if the corpus is not 100% compliant causing Travis to skip the build and release steps. Because of the way Travis is set up, we recommend not setting `--workers` higher than 3.

.. code-block:: yml
.. code-block:: yaml
before_deploy:
- hooktest-build --travis --txt ./
Expand All @@ -202,7 +202,7 @@ Of special note here are two things that you will need to set up yourself. The f

The second important change to this line is to replace the string "YOUR_REPOSITORY_NAME" with the Github user name or organization name and the repository name, e.g., "OpenGreekAndLatin/First1KGreek". If any of these pre-deployment steps fail, then the repository will not build and release.

.. code-block:: yml
.. code-block:: yaml
deploy:
provider: releases
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

setup(
name='HookTest',
version="1.2.1",
version="1.2.2",
description='Hook Test Script for GitHub/CapiTainS repositories',
long_description=long_description,
long_description_content_type="text/x-rst",
Expand Down

0 comments on commit e767519

Please sign in to comment.