Skip to content

Commit

Permalink
add note about github permissions
Browse files Browse the repository at this point in the history
Signed-off-by: vsoch <vsoch@users.noreply.github.com>
  • Loading branch information
vsoch committed Mar 9, 2023
1 parent f1248dd commit 1f88026
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
19 changes: 17 additions & 2 deletions docs/getting_started/developer-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1115,9 +1115,24 @@ That will generate a container.yaml with executables discovered:
salad: /code/salad
You can then push this to GitHub. If you are curious about how the docs are generated, you can
try it locally:

.. code-block:: console
$ git checkout gh-pages
$ ./generate.sh /tmp/my-registry
Registry is /tmp/my-registryGenerating docs for vsoch/salad, _library/vsoch-salad.md
There is also an associated workflow to run the same on your behalf. Note that you'll need
to enable the repository to allow actions to open pull requests for this to work.
The workflow is under ``Actions --> Generate New Container --> Run Workflow``.
to:

1. Go to the ``repository --> Settings --> Actions --> Workflow Permissions`` and enable read and write.
2. Directly under that, check the box to allow actions to open pull requests for this to work.

If you get a message about push being denied to the bot, you forgot to do one of these steps!
The workflow is under ``Actions --> shpc new recipe manual --> Run Workflow``.
Remember that any container, once it goes into the registry, will have tags
and digests automatically updated via the "Update Containers" action workflow.

Expand Down
2 changes: 1 addition & 1 deletion shpc/main/modules/base.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
__author__ = "Vanessa Sochat"
__copyright__ = "Copyright 2021-2032, Vanessa Sochat"
__copyright__ = "Copyright 2021-2023, Vanessa Sochat"
__license__ = "MPL 2.0"

import inspect
Expand Down

0 comments on commit 1f88026

Please sign in to comment.