Skip to content

Commit

Permalink
update installation instruction and add timeline entry for 0.13.0
Browse files Browse the repository at this point in the history
  • Loading branch information
shahzebsiddiqui committed Jan 20, 2022
1 parent 5e2e501 commit 320ddde
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
24 changes: 15 additions & 9 deletions docs/installing_buildtest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,35 +40,41 @@ Installing buildtest
buildtest requires a python 3.7 or higher, we recommend you setup a python environment in order
to install buildtest. You can use `venv <https://docs.python.org/3/library/venv.html>`_, `conda <https://conda.io/>`_,
or `pipenv <https://pipenv.readthedocs.io/en/latest/>`_ to manage your python environment depending on your preference.
Assuming you have cloned buildtest in your HOME directory you will need to follow these instructions to install buildtest.

.. tabs::

.. tab:: Virtual Environment
.. tab:: Virtual Environment (bash)

::

python3 -m venv $HOME/buildtest
source $HOME/buildtest/bin/activate
cd buildtest
source setup.sh
python3 -m venv $HOME/.pyenv/buildtest
source $HOME/.pyenv/buildtest/bin/activate
source $HOME/buildtest/setup.sh

.. tab:: Virtual Environment (csh)

::

python3 -m venv $HOME/.pyenv/buildtest
source $HOME/.pyenv/buildtest/bin/activate.csh
source $HOME/buildtest/setup.csh

.. tab:: Conda

::

conda create -n buildtest python=3.7
source activate buildtest
cd buildtest
source setup.sh
source $HOME/buildtest/setup.sh

.. tab:: pipenv

::

pipenv --python 3.7
pipenv shell
cd buildtest
source setup.sh
source $HOME/buildtest/setup.sh

For csh users you will need to ``source setup.csh`` in order to install buildtest.

Expand Down
1 change: 1 addition & 0 deletions docs/what_is_buildtest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ Timeline
:header: "Date", "Version", "Description"
:widths: 20, 20, 80

**Jan 20th 2022**, "`v0.13.0 <https://github.com/buildtesters/buildtest/releases/tag/v0.13.0>`_", "Add options ``--proc`` and ``--nodes`` to **buildtest build** to specify arbitrary process and node count for batch jobs. Add new commands ``buildtest unittests`` and ``buildtest stylecheck``. Allow one to specify alternate python wrapper via environment ``BUILDTEST_PYTHON``. "
**Dec 17th 2021**, "`v0.12.0 <https://github.com/buildtesters/buildtest/releases/tag/v0.12.0>`_", "Make use of `rich <https://rich.readthedocs.io/en/stable/index.html>`_ library for printing output for various buildtest commands. Add new commands such ``buildtest debugreport`` and ``buildtest config edit``. We removed few commands including ``buildtest config summary``, ``buildtest inspect id``."
**Sep 9th 2021**, "`v0.11.0 <https://github.com/buildtesters/buildtest/releases/tag/v0.11.0>`_", "Re-implement core implementation of running and polling jobs using asynchronous job submission. In addition we added several new commands including: **buildtest cd**, **buildtest path** and **buildtest path** and we enable alias for sub-commands."
**Aug 16th 2021**, "`v0.10.2 <https://github.com/buildtesters/buildtest/releases/tag/v0.10.2>`_", "Add support for multi executor support in buildspec via ``executors`` property. Add new commands ``buildtest report summary`` for summary of report file. The ``buildtest buildspec show`` command shows content of buildspec file given a test name. The ``buildtest edit`` command can be used to edit buildspec and validate with JSON schema upon closing file. In this release, we added ``buildtest inspect buildspec`` command to view records based on buildspec file."
Expand Down

0 comments on commit 320ddde

Please sign in to comment.