Skip to content

Commit

Permalink
Update readme test/deploy instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
aktech committed Apr 23, 2020
1 parent f8637ea commit f99634e
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 6 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,9 @@ my/

# IntelliJ/Jetbrains
.idea

# Credentials
client-secret.json

# app engine lib
lib
19 changes: 13 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,15 @@ This is a local server that runs on port 8080 (use ``--port`` option to
change this). Open a web browser and go to http://localhost:8080. You
should see GUI of SymPy Gamma.

Uploading to GAE (Manually)
---------------------------
Deploying to GAE
----------------

Travis-CI is used to deploy automatically to the official server. To upload
the application manually, you need to do a few things. First, tag the
Travis-CI is used to deploy automatically to the official server via Github Releases.
Go to https://github.com/sympy/sympy_gamma/releases and click on create a release and
name the release as version-NN where NN is the release version. After this travis will
automatically release the version NN.

To upload the application manually, you need to do a few things. First, tag the
current commit with the App Engine application version (this is not
necessary unless you are deploying to the official server)::

Expand Down Expand Up @@ -119,6 +123,7 @@ the ``Versions`` section of the sympy_gamma dashboard, and set this as the
new default version. If there are any issues, you can roll back to the
previous version from this same screen.


Creating Deployment Credentials
-------------------------------

Expand Down Expand Up @@ -159,8 +164,8 @@ pull request, so that others can easily review your work, without even having
to use ``dev_appserver.py``.

Branch builds are automatically deployed by Travis to
`https://N-dot-sympy-gamma-tests.appspot.com/`, where `N` is the branch name.
Note that the pull request has to from a branch on this repository, as
`https://<BRANCH-NAME>-dot-sympy-gamma-hrd.appspot.com/`.
Note that the pull request has to be from a branch on this repository, as
forks do not have access to the key to deploy to the app engine.

Development notes
Expand Down Expand Up @@ -198,6 +203,8 @@ To be able to run tests, make sure you have testing libraries installed::
npm install -g casperjs
pip install nose

Install phantomjs for your system from: https://phantomjs.org/download.html

To run unit tests::

PYTHONPATH='.' nosetests app/test -vv
Expand Down

0 comments on commit f99634e

Please sign in to comment.