Merge pull request #770 from buildtesters/fix_docs

0.9.6 release

CHANGELOG.rst

@@ -1,9 +1,10 @@
 CHANGELOG
 =========
 
-v0.9.6 or v0.10.0 (TBD)
-------------------------
+v0.9.6 (June 11th, 2021)
+-------------------------
 
+- Add command ``buildtest history`` to keep track of builds with command names ``buildtest history list`` and ``buildtest history query <id>`` to retrieve specific builds. buildtest will keep track of every ``buildtest build`` command for retrieval. See #`767 <https://github.com/buildtesters/buildtest/pull/767>`_
 - Change behavior of how test are generated by introducing a build script that ends in `_build.sh` script which is used for running the script. In `#751 <https://github.com/buildtesters/buildtest/pull/751>`_ we
   are able to properly handle returncode of generated script. We updated the buildtest installation by installing dependencies in $BUILDTEST_ROOT/.packages using ``pip install --target`` which addressed issue
   in buildtest installation if user was to install outside of virtual environment.

README.rst

@@ -67,7 +67,7 @@ for their system. In buildtest, you will write tests in `YAML <https://yaml.org/
 called **Buildspecs** which is a test recipe used by buildtest for generating test scripts.
 buildtest will process *buildspecs* and automatically create shell-scripts and run them
 on your system. buildtest supports `IBM Spectrum LSF <https://www.ibm.com/support/knowledgecenter/SSWRJV_10.1.0/lsf_welcome/lsf_welcome.html>`_,
-`Slurm <https://slurm.schedmd.com/>`_, and `Cobalt <https://trac.mcs.anl.gov/projects/cobalt/>`_ batch scheduler for job submission.
+`Slurm <https://slurm.schedmd.com/>`_, `PBS <https://www.openpbs.org/>`_ and `Cobalt <https://trac.mcs.anl.gov/projects/cobalt/>`_ batch scheduler for job submission.
 buildtest makes use of `jsonschema <https://json-schema.org/>`_ to define structure of buildspecs used for validating buildspecs. 
 
 If you want to learn more about buildtest read https://buildtest.readthedocs.io/en/latest/what_is_buildtest.html.
@@ -83,7 +83,7 @@ Installing buildtest, is relatively easy. Just clone this repo and source the se
     source setup.sh
 
 
-For more details see `installing buildtest <https://buildtest.readthedocs.io/en/latest/installing_buildtest.html>`_.
+For more details see `Installing buildtest <https://buildtest.readthedocs.io/en/latest/installing_buildtest.html>`_.
 
 
 Schema Development

buildtest/__init__.py

@@ -1,3 +1,3 @@
-BUILDTEST_VERSION = "0.9.5"
+BUILDTEST_VERSION = "0.9.6"
 __version__ = BUILDTEST_VERSION
 BUILDTEST_COPYRIGHT = "Copyright (c) 2021, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy), Shahzeb Siddiqui, and Vanessa Sochat. All rights reserved."

buildtest/cli/build.py

@@ -1111,6 +1111,7 @@ def _update_build_history(self):
         that is incremented such as 0, 1, 2 in **$BUILDTEST_ROOT/var/.history** which is used to differentiate builds.
         """
 
+        create_dir(BUILD_HISTORY_DIR)
         num_files = len(os.listdir(BUILD_HISTORY_DIR))
         # create a sub-directory in $BUILDTEST_ROOT/var/.history/ that is incremented for every build starting with 0, 1, 2, ...
         build_history_dir = os.path.join(BUILD_HISTORY_DIR, str(num_files))

buildtest/cli/history.py

@@ -61,6 +61,11 @@ def query_builds(build_id, log_option):
     :type log_option: bool, required
     """
 
+    if not is_dir(BUILD_HISTORY_DIR):
+        sys.exit(
+            f"Unable to find history directory: {BUILD_HISTORY_DIR}, seems like you have not run any builds using 'buildtest build' command."
+        )
+
     num_ids = list(range(len(os.listdir(BUILD_HISTORY_DIR))))
 
     if not is_dir(os.path.join(BUILD_HISTORY_DIR, str(build_id))):

buildtest/main.py

@@ -42,7 +42,6 @@ def main():
     create_dir(BUILDTEST_USER_HOME)
     create_dir(BUILDTEST_EXECUTOR_DIR)
     create_dir(BUILDTEST_BUILDSPEC_DIR)
-    create_dir(BUILD_HISTORY_DIR)
 
     # Create a build test system, and check requirements
     system = BuildTestSystem()

docs/buildspecs/compiler.rst

@@ -1005,7 +1005,7 @@ shell-script. If no ``run`` field is specified buildtest will run the binary in
 
 .. code-block:: shell
    :linenos:
-   :emphasize-lines: 6
+   :emphasize-lines: 5
 
     #!/bin/bash
     _EXEC=argc.c.exe

docs/index.rst

@@ -36,25 +36,16 @@ Status
 Useful Links
 -------------
 
-- Source Code: https://github.com/buildtesters/buildtest
-
-- Documentation: http://buildtest.rtfd.io/
-
-- Schema Docs: https://buildtesters.github.io/buildtest/
-
-- ReadTheDocs: https://readthedocs.org/projects/buildtest/
-
-- CodeCov: https://codecov.io/gh/buildtesters/buildtest
-
-- Slack Channel: http://hpcbuildtest.slack.com
-
-- Slack Invite: https://hpcbuildtest.herokuapp.com
-
-- CodeFactor: https://www.codefactor.io/repository/github/buildtesters/buildtest
-
-- Snyk: https://app.snyk.io/org/buildtesters/
-
-- Cori Test Repository: https://github.com/buildtesters/buildtest-cori
+1. Source Code: https://github.com/buildtesters/buildtest
+2. Documentation: http://buildtest.rtfd.io/
+3. Schema Docs: https://buildtesters.github.io/buildtest/
+4. ReadTheDocs: https://readthedocs.org/projects/buildtest/
+5. CodeCov: https://codecov.io/gh/buildtesters/buildtest
+6. Slack Channel: http://hpcbuildtest.slack.com
+7. Slack Invite: https://hpcbuildtest.herokuapp.com
+8. CodeFactor: https://www.codefactor.io/repository/github/buildtesters/buildtest
+9. Snyk: https://app.snyk.io/org/buildtesters/
+10. Cori Test Repository: https://github.com/buildtesters/buildtest-cori
 
 Description
 ------------