Skip to content

Commit

Permalink
Add RELEASE comments for release checklist
Browse files Browse the repository at this point in the history
  • Loading branch information
gilch committed Nov 10, 2024
1 parent 9eae82f commit 42fb1d9
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ It's Python with a *Lissp*.
Hissp is a modular Lisp implementation that compiles to a functional subset of
Python—Syntactic macro metaprogramming with full access to the Python ecosystem!

[//]: # (RELEASE: refresh toc)
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
**Table of Contents**

Expand Down
2 changes: 2 additions & 0 deletions conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,3 +99,5 @@ def __contains__(self, item):
parsers=[ParseLissp(optionflags=ELLIPSIS)],
filenames=Globs("*.md", "*.rst", "*.lissp"),
).pytest()

# RELEASE: Run all tests.
2 changes: 2 additions & 0 deletions docs/command_line_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ also install the ``lissp`` command-line tool for running Lissp code.
This is a convenience executable for starting ``python -m hissp``,
whose minimal options were modeled after Python's most commonly used:

.. RELEASE: Update (Hissp X.X.X) line.
.. code-block:: Text
usage: lissp [-h] [-i] [-c cmd] [file] [args [args ...]]
Expand Down
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,3 +99,5 @@
html_static_path = ["_static"]

intersphinx_mapping = {"python": ("https://docs.python.org/3.10", None)}

# RELEASE: Make sure to clean build docs and check for errors.
1 change: 1 addition & 0 deletions docs/lissp_whirlwind_tour.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
... __import__('hissp')._macro_)))
.. TODO: Interactive via web repl?
.. RELEASE: Update the ;;;; Installation section.
Lissp Whirlwind Tour
====================
Expand Down
2 changes: 2 additions & 0 deletions docs/primer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ Confirm your Python version with
(Re-)install the Hissp version matching this document with

.. RELEASE: Rewrite to install from PyPI.
.. code-block:: console
$ python -m pip install --upgrade --force-reinstall git+https://github.com/gilch/hissp
Expand Down
4 changes: 4 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,7 @@
)
# Build dist and install:
# python setup.py bdist_wheel && pip install --force-reinstall setup\dist\hissp-*.whl

# RELEASE: Double-check setup data.
# RELEASE: Clean build macros.py and make sure it's in the .whl.
# RELEASE: Inspect all files in the .whl.
2 changes: 1 addition & 1 deletion src/hissp/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
with __import__("contextlib").suppress(ImportError):
from hissp.macros import _macro_

VERSION = "0.5.dev"
VERSION = "0.5.dev" # RELEASE


def prelude(env):
Expand Down

0 comments on commit 42fb1d9

Please sign in to comment.