Skip to content

Commit

Permalink
docs: Add some extra explanation of "Publish packages for branch".
Browse files Browse the repository at this point in the history
I hadn't used this feature for a while, and realised there's one confusing
element of it not previously mentioned in the docs.

Signed-off-by: Angus Gratton <[email protected]>
  • Loading branch information
projectgus committed Feb 20, 2024
1 parent 4cc6706 commit bc7ee4f
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,15 +102,20 @@ Pages](https://docs.github.com/en/pages):
"truthy" value).
5. The settings for GitHub Actions and GitHub Pages features should not need to
be changed from the repository defaults, unless you've explicitly disabled
them.
Actions or Pages in your fork.

The next time you push commits to a branch in your fork, GitHub Actions will run
an additional step in the "Build All Packages" workflow named "Publish Packages
for branch".
for branch". This step runs in *your fork*, but if you open a pull request then
this workflow is not shown in the Pull Request's "Checks". These run in the
upstream repository. Navigate to your fork's Actions tab in order to see
the additional "Publish Packages for branch" step.

Anyone can then install these packages as described under [Installing packages
from forks](README.md#installing-packages-from-forks). The exact commands are also
quoted in the GitHub Actions log for the "Publish Packages for branch" step.
from forks](README.md#installing-packages-from-forks).

The exact command is also quoted in the GitHub Actions log in your fork's
Actions for the "Publish Packages for branch" step of "Build All Packages".

#### Opting Back Out

Expand Down

0 comments on commit bc7ee4f

Please sign in to comment.