Skip to content

Commit

Permalink
add pull request tips and setting a public tips
Browse files Browse the repository at this point in the history
  • Loading branch information
joshspicer authored Aug 27, 2024
1 parent 34897f7 commit 27ac120
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ To best get started, create your own repo from the [`devcontainers/feature-start

### Permissions

#### Workflow permissions

Running this action requires the following [permissions](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token) be granted:

- `packages: write`
Expand Down Expand Up @@ -52,6 +54,20 @@ jobs:
base-path-to-templates: "./src"
```
#### Enable creation of pull requests
This action will auto-generate documentation and generate a pull request for your review.
Ensure [**Allow GitHub Actions to create and approve pull requests**](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#preventing-github-actions-from-creating-or-approving-pull-requests) is enabled in your repo.
#### Optional: Setting Features/Templates as public
Features or Templates published to a registry are private by default. To share your Feature or Template with others outside your organization, you can update the visibility to public.
To do so, publish your Feature or Template and navigate to its setting page. To see packages you have published to the GitHub Container Registry, navigate to the following URL:
`https://github.com/<YOUR_GITHUB_USERNAME>?tab=packages`

### Pinning `devcontainer` CLI version

This action heavily relies on the [devcontainers/cli](https://github.com/devcontainers/cli) for various operations. By default, this action will fetch the latest version published to [npm](https://www.npmjs.com/package/@devcontainers/cli). The `devcontainer-cli-version` property can be used to pin to a specific CLI release. Eg:
Expand Down

0 comments on commit 27ac120

Please sign in to comment.