Skip to content

Commit

Permalink
Move the package publishing documentation out of readme (#149)
Browse files Browse the repository at this point in the history
Continuing the work started in [1] for easier documentation consumption
and maintenance.

[1] 633ccad ("Set up an initial documentation structure (#81)")
  • Loading branch information
jstasiak authored Jul 5, 2024
1 parent 3893100 commit c1c9d96
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 14 deletions.
13 changes: 0 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,16 +145,3 @@ if (optionalUrl.some) {

See https://ts-results-es.readthedocs.io/en/latest/reference/api/index.html to see the API
reference.

## Publishing the package

The package is published manually right now.

Steps to publish:

1. Bump the version in `package.json` and `src/package.json` as needed
2. Update the CHANGELOG
3. Commit to Git in a single commit and add a tag: `git tag -a vX.X.X` (the tag description can be
anything)
4. `npm run build && npm publish`
5. Push both the `master` branch and the new tag to GitHub
13 changes: 13 additions & 0 deletions docs/dev/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Publishing the package
======================

The package is published manually right now.

Steps to publish:

1. Bump the version in ``package.json`` and ``src/package.json`` as needed
2. Update the CHANGELOG
3. Commit to Git in a single commit and add a tag: ``git tag -a vX.X.X`` (the tag description can be
anything)
4. ```npm run build && npm publish```
5. Push both the ``master`` branch and the new tag to GitHub
8 changes: 7 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ The documentation will live here.

.. toctree::
:maxdepth: 2
:caption: Contents:
:caption: User documentation:

reference/index

.. toctree::
:maxdepth: 1
:caption: Developer documentation:

dev/index

0 comments on commit c1c9d96

Please sign in to comment.