Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,5 @@ jobs:
run: pnpm run type-check
- name: Build
run: pnpm run build
- name: Release
run: pnpx pkg-pr-new publish --bin --commentWithSha --pnpm --packageManager=pnpm './packages/create-vue-lib'
3 changes: 3 additions & 0 deletions packages/create-vue-lib/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ type Config = {
includeEsLintStylistic: boolean
includeVitest: boolean
includeGithubCi: boolean
includePkgPrNew: boolean
includeAtAliases: boolean
includeTestVariable: boolean
includeTailwind: boolean
Expand Down Expand Up @@ -275,6 +276,7 @@ async function init() {
const includeGithubPages = includeDocs && await togglePrompt('Include GitHub Pages config for documentation?')
const includePlayground = await togglePrompt('Include playground application for development?', true)
const includeGithubCi = await togglePrompt('Include GitHub CI configuration?', !!githubPath)
const includePkgPrNew = includeGithubCi && await togglePrompt('Include pkg.pr.new in CI configuration?', false)
const includeExamples = await togglePromptIf(extended, 'Include example code?', true, 'Yes', 'No, just configs')
const includeAtAliases = await togglePromptIf(extended, 'Configure @ as an alias for src?')
const includeTestVariable = await togglePromptIf(extended, 'Configure global __TEST__ variable?')
Expand Down Expand Up @@ -342,6 +344,7 @@ async function init() {
includeEsLintStylistic,
includeVitest,
includeGithubCi,
includePkgPrNew,
includeAtAliases,
includeTestVariable,
includeTailwind,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,7 @@ jobs:
- name: Test
run: pnpm run test:unit
<%_ } _%>
<%_ if (config.includePkgPrNew) { _%>
- name: Release
run: pnpx pkg-pr-new publish --commentWithSha --pnpm --packageManager=pnpm,npm,yarn './<%- config.packagesDir %><%- config.mainPackageDirName %>'
<%_ } _%>
11 changes: 11 additions & 0 deletions packages/docs/src/questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
<span class="check">✔</span> <a href="#include-github-pages">Include GitHub Pages config for documentation? … No / Yes</a>
<span class="check">✔</span> <a href="#include-playground">Include playground application for development? … No / Yes</a>
<span class="check">✔</span> <a href="#include-github-ci">Include GitHub CI configuration? … No / Yes</a>
<span class="check">✔</span> <a href="#include-pkg-pr-new">Include pkg.pr.new in CI configuration? … No / Yes</a>
<span class="check">✔</span> <a href="#include-examples">Include example code? … No, just configs / Yes</a>
<span class="check">✔</span> <a href="#configure-src-alias">Configure @ as an alias for src? … No / Yes</a>
<span class="check">✔</span> <a href="#configure-test-variable">Configure global __TEST__ variable? … No / Yes</a></pre>
Expand Down Expand Up @@ -226,6 +227,16 @@ This option will include a GitHub Actions configuration for a CI workflow. It wi

If a [GitHub path](#github-path) has been provided, the job will be configured so that it only runs for that specific fork.

## Include pkg.pr.new in CI configuration?{#include-pkg-pr-new}

:::info NOTE
You'll only see this question if you chose to include GitHub CI configuration.
:::

[pkg.pr.new](https://github.com/stackblitz-labs/pkg.pr.new) allows for continuous releases. Every PR and every commit to `main` will be published as a package on pkg.pr.new, which is similar to the npm registry but with each 'release' tied to a specific commit rather than a version number. This allows changes to be installed and tested before they're merged or released to npm.

You'll also need to install the [pkg.pr.new GitHub App](https://github.com/apps/pkg-pr-new) and enable it on your GitHub repository.

## Include example code?{#include-examples}

:::info NOTE
Expand Down
Loading